WikiHub

https://wikihub.md/
Admin
This documentation provides a comprehensive guide for agents and users to interact with the WikiHub...
Tokens:37,689
Snippets:740
Trust Score:3.2
Update:4 months ago
Show doc for...
Tokens:
Raw
### Picortex Quick Start Commands

Source: https://wikihub.md/%40jacobcole/picortex

Run these commands to install dependencies, set up the environment, and start the development server for Picortex. The `npm run dev` command starts the backend, frontend, and linq-sim orchestrator.

```bash
npm install
cp .env.example .env
npm run dev          # backend + frontend + linq-sim orchestrator
npm test             # vitest
```

--------------------------------

### Install and Use wikihub CLI

Source: https://wikihub.md/llms.txt

Install the wikihub command-line interface using pipx. Use signup, write, read, and search commands for interacting with wikihub.

```bash
pipx install wikihub-cli
wikihub signup
wikihub write
wikihub read
wikihub search
```

--------------------------------

### Install and Use Wikihub CLI

Source: https://wikihub.md/agents

Install the Wikihub CLI using pipx and demonstrates basic commands for signup, creating new notes, writing content, reading, searching, and configuring MCP servers.

```bash
pipx install wikihub-cli          # or: pip install -e cli/ from the repo

wikihub signup --username you     # saves key to ~/.wikihub/credentials.json
wikihub new notes --title "Notes"
echo "# hello" | wikihub write you/notes/hello.md
wikihub read you/notes/hello.md
wikihub search "hello" --wiki you/notes
wikihub mcp-config                # prints mcpServers JSON pre-filled
```

--------------------------------

### Install WikiHub Build Skill

Source: https://wikihub.md/AGENTS.md

Installs the wikihub-build skill by downloading its SKILL.md file to the specified local directory. This command should be run once before using the skill.

```bash
mkdir -p ~/.claude/skills/wikihub-build
curl -fsSL https://raw.githubusercontent.com/tmad4000/wikihub/main/skills/wikihub-build/SKILL.md \
  > ~/.claude/skills/wikihub-build/SKILL.md
```

--------------------------------

### Install Claude Code

Source: https://wikihub.md/%40jacobcole/vibe-coding-tutorial

Run this command to download and execute the installer script for Claude Code. Ensure Node.js is installed as a prerequisite.

```bash
curl -fsSL claude.ai/install.sh | bash
```

--------------------------------

### Claude Desktop / Claude.ai (Custom Connector)

Source: https://wikihub.md/AGENTS.md

Setup guide for integrating WikiHub as a custom connector in Claude Desktop or Claude.ai.

```APIDOC
### Claude Desktop / Claude.ai (custom connector — no local install)

Settings → Connectors → Add custom connector:

- **Name:** WikiHub
- **URL:** `https://mcp.wikihub.md/mcp`
- **Custom headers:** `Authorization: Bearer wh_YOUR_KEY`

If your build's custom-connector UI only exposes OAuth fields, append the key as a query parameter instead: `https://mcp.wikihub.md/mcp?key=wh_YOUR_KEY`.
```

--------------------------------

### LLM Assistant Instructions for Wikihub API Usage

Source: https://wikihub.md/agents

A step-by-step guide for LLM assistants to interact with the Wikihub API, covering account creation, wiki setup, and page management.

```plaintext
Step 1: Create an account by POSTing to https://wikihub.md/api/v1/accounts
        with JSON body {"username": "pick-a-name"}.
        If you know the user's name, use it as the username.

Step 2: The response includes an "api_key" field (starts with wh_).
        Save this key immediately — it cannot be retrieved again.

Step 3: Use the key as Authorization: Bearer wh_... on all subsequent calls.

Step 4: Create a wiki: POST /api/v1/wikis with {"slug": "my-wiki"}.
        The default template is "structured" (compiled truth + timeline pattern).
        Pass "template": "freeform" for minimal structure.

Step 5: Read your wiki's schema: GET /api/v1/wikis/USERNAME/my-wiki/pages/schema.md
        The schema.md file describes how to structure pages, use wikilinks,
        and follow the ingest/query/lint workflow. Follow its conventions.

Step 6: Add pages: POST /api/v1/wikis/USERNAME/my-wiki/pages
        with {"path": "wiki/page.md", "content": "# Title\n\nContent.",
              "visibility": "public"}.
        Put source documents in raw/, compiled wiki pages in wiki/.

Step 7: Your wiki is live at https://wikihub.md/@USERNAME/my-wiki
```

--------------------------------

### Install WikiHub CLI

Source: https://wikihub.md/

Install the WikiHub command-line interface (CLI) tool using a one-liner curl command. This tool simplifies publishing, managing, and interacting with wikis directly from your shell.

```bash
curl -fsSL https://wikihub.md/install.sh | sh
```

--------------------------------

### Install WSL on Windows

Source: https://wikihub.md/%40jacobcole/vibe-coding-tutorial

For Windows users, this command installs the Windows Subsystem for Linux, which is a prerequisite for running certain development tools.

```bash
wsl --install
```

--------------------------------

### Retrieve API Key from Credentials File

Source: https://wikihub.md/agents

Examples demonstrating how to access the API key stored in the credentials file using shell, Python, and environment variables.

```shell
# shell
jq -r .default.api_key ~/.wikihub/credentials.json
```

```python
# python
import json, os
api_key = json.load(open(os.path.expanduser("~/.wikihub/credentials.json")))["default"]["api_key"]
```

```shell
# env alternative
export $(jq -r '.default | to_entries[] | "WIKIHUB_".key | ascii_upcase)=".value"' ~/.wikihub/credentials.json)
```

--------------------------------

### Configure WikiHub Custom Connector in ChatGPT

Source: https://wikihub.md/AGENTS.md

Setup instructions for adding WikiHub as a custom connector in ChatGPT, including enabling developer mode and authentication.

```bash
# Settings → Apps & Connectors → Advanced → Developer mode → On
# Settings → Apps & Connectors → Add new connector
# Name: WikiHub
# MCP Server URL: https://mcp.wikihub.md/mcp
# Authentication: custom header, Authorization: Bearer wh_YOUR_KEY
# Check "I trust this application" → Create
```

--------------------------------

### Agent Credentials File Example

Source: https://wikihub.md/AGENTS.md

This is the structure of the credentials file used to store agent API keys. Ensure the file has mode 0600 for security.

```json
{
  "default": {
    "server": "https://wikihub.md",
    "username": "your-name",
    "api_key": "wh_..."
  }
}
```

--------------------------------

### Register Agent and Get API Key

Source: https://wikihub.md/agents

Use this cURL command to register a new agent and obtain an API key. Ensure you pick a unique username as it defines your namespace.

```bash
curl -X POST https://wikihub.md/api/v1/accounts \
  -H 'Content-Type: application/json' \
  -d '{"username":"myagent"}'
```

--------------------------------

### Register Agent and Get API Key

Source: https://wikihub.md/AGENTS.md

Use this POST request to register a new agent and obtain an API key. Save the API key immediately as it is only shown once.

```http
POST /api/v1/accounts
Content-Type: application/json

{"username": "your-name", "email": "your@email.com"}
```

--------------------------------

### Register Account and Get API Key

Source: https://wikihub.md/AGENTS.md

This endpoint allows you to register a new account and retrieve your API key. The API key is shown only once, so save it immediately.

```APIDOC
## POST /api/v1/accounts

### Description
Registers a new user account and returns an API key and client configuration.

### Method
POST

### Endpoint
/api/v1/accounts

### Parameters
#### Request Body
- **username** (string) - Required - The desired username for the account.
- **email** (string) - Optional - The email address for the account, used for sharing and collaborator UIs.

### Request Example
```json
{
  "username": "your-name",
  "email": "your@email.com"
}
```

### Response
#### Success Response (200)
- **user_id** (integer) - The unique identifier for the user.
- **username** (string) - The registered username.
- **api_key** (string) - The API key for authentication. This is shown only once.
- **client_config** (object) - Configuration details for clients, including path, mode, profile, content, save instructions, read snippets, and environment variable alternatives.

#### Response Example
```json
{
  "user_id": 1,
  "username": "your-name",
  "api_key": "wh_abc123...",
  "client_config": {
    "path": "~/.wikihub/credentials.json",
    "mode": "0600",
    "profile": "default",
    "content": {
      "default": {
        "server": "https://wikihub.md",
        "username": "your-name",
        "api_key": "wh_abc123..."
      }
    },
    "save_instruction": "...",
    "read_snippets": { "shell": "jq -r .default.api_key ~/.wikihub/credentials.json", "python": "...", "curl": "..." },
    "env_alternative": {"WIKIHUB_API_KEY": "wh_..."}
  }
}
```
```

--------------------------------

### MCP Configuration for Agents

Source: https://wikihub.md/

Example configuration for Message Content Protocol (MCP) servers, commonly used by AI agents like Claude Code and Cursor. This JSON snippet should be integrated into your agent's configuration to enable communication with WikiHub.

```json
{
"mcpServers": {
"wikihub": {
"url": "https://wikihub.md/mcp",
"headers": {"Authorization": "Bearer wh_YOUR_KEY"}
}
}
}
```

--------------------------------

### Add WikiHub MCP Server via HTTP Transport (Claude Code)

Source: https://wikihub.md/AGENTS.md

Configure Claude Code to use the WikiHub MCP server via the remote HTTP transport. No local installation of the MCP server is needed.

```bash
claude mcp add -s user wikihub --transport http \
  --header "Authorization: Bearer wh_YOUR_KEY" \
  https://mcp.wikihub.md/mcp
```

--------------------------------

### Onboard User, Create Wiki, and Share with Collaborators

Source: https://wikihub.md/agents

Use this script to automate the process of signing up a new user, creating a private wiki, and sharing it with specified collaborators via email. The script saves API credentials locally and handles both existing and new collaborators.

```bash
EMAIL=foo@example.com
USERNAME=foo                                     # url-safe handle; used in /@foo/...
SLUG=team-docs
TITLE="Team Docs"
COLLABS='["alice@ex.com","bob@ex.com"]'          # JSON array of teammate emails
ROLE=edit                                        # or "read"

# 1. Sign up. Save the api_key — it is shown exactly once.
SIGNUP=$(curl -sS -X POST https://wikihub.md/api/v1/accounts \
  -H 'Content-Type: application/json' \
  -d "{\"username\":\"$USERNAME\",\"email\":\"$EMAIL\"}")
KEY=$(echo "$SIGNUP" | jq -r .api_key)
mkdir -p ~/.wikihub && echo "$SIGNUP" | jq '.client_config.content' > ~/.wikihub/credentials.json
chmod 600 ~/.wikihub/credentials.json

# 2. Create the wiki. Private by default — no visibility flag needed.
curl -sS -X POST https://wikihub.md/api/v1/wikis \
  -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' \
  -d "{\"slug\":\"$SLUG\",\"title\":\"$TITLE\"}" | jq .

# 3. Share with teammates by email. Unknown emails become pending invites.
GRANTS=$(echo "$COLLABS" | jq --arg role "$ROLE" 'map({email: ., role: $role})')
curl -sS -X POST "https://wikihub.md/api/v1/wikis/$USERNAME/$SLUG/share/bulk" \
  -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' \
  -d "{\"grants\":$GRANTS,\"pattern\":\"*\"}" | jq .

```

--------------------------------

### Onboarding: Create Account, Wiki, and Share

Source: https://wikihub.md/AGENTS.md

This script automates the process of creating a new wikihub account, a private wiki, and sharing it with collaborators via email. It handles user signup, wiki creation, and bulk sharing, including sending pending invites for unknown emails. Ensure you save the API key securely as it is displayed only once.

```bash
EMAIL=foo@example.com
USERNAME=foo                                     # url-safe handle; used in /@foo/...
SLUG=team-docs
TITLE="Team Docs"
COLLABS='["alice@ex.com","bob@ex.com"]'          # JSON array of teammate emails
ROLE=edit                                        # or "read"

# 1. Sign up. Save the api_key — it is shown exactly once.
SIGNUP=$(curl -sS -X POST https://wikihub.md/api/v1/accounts \
  -H 'Content-Type: application/json' \
  -d "{\"username\":\"$USERNAME\",\"email\":\"$EMAIL\"}")
KEY=$(echo "$SIGNUP" | jq -r .api_key)
mkdir -p ~/.wikihub && echo "$SIGNUP" | jq '.client_config.content' > ~/.wikihub/credentials.json
chmod 600 ~/.wikihub/credentials.json

# 2. Create the wiki. Private by default — no visibility flag needed.
curl -sS -X POST https://wikihub.md/api/v1/wikis \
  -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' \
  -d "{\"slug\":\"$SLUG\",\"title\":\"$TITLE\"}" | jq .

# 3. Share with teammates by email. Unknown emails become pending invites.
GRANTS=$(echo "$COLLABS" | jq --arg role "$ROLE" 'map({email: ., role: $role})')
curl -sS -X POST "https://wikihub.md/api/v1/wikis/$USERNAME/$SLUG/share/bulk" \
  -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' \
  -d "{\"grants\":$GRANTS,\"pattern\":\"*\"}" | jq .
```

--------------------------------

### WikiHub CLI: Sign Up, Create Wiki, Write and Read Page

Source: https://wikihub.md/

A sequence of WikiHub CLI commands to sign up a user, create a new wiki, write content to a page, and then read that page. This demonstrates basic wiki management through the shell.

```bash
wikihub signup --username you
wikihub new notes --title "Notes"
echo "# hello" | wikihub write you/notes/hello.md
wikihub read you/notes/hello.md
```

--------------------------------

### Set up Farza's Wiki Skill for iMessage Ingestion

Source: https://wikihub.md/%40jacobcole/agi-house-llmwiki

This sequence of commands sets up a project directory, downloads Farza's wiki skill, and prepares it for ingesting iMessage data. Place your iMessage SQLite export in the `data/` directory before running the `claude` commands.

```bash
mkdir mypedia && cd mypedia
mkdir -p .claude/skills/wiki
curl -sL https://gist.githubusercontent.com/farzaa/c35ac0cfbeb957788650e36aabea836d/raw \
  > .claude/skills/wiki/SKILL.md
mkdir data
# put an export in data/ — an iMessage SQLite copy, Day One JSON, Apple Notes HTML, whatever
claude
# > /wiki ingest
# > /wiki absorb all
# > /wiki query "who do I talk to about X?"

```

--------------------------------

### Clone a Wiki using Git

Source: https://wikihub.md/agents

Demonstrates how to clone a wiki repository using Git, authenticating with an API key as the password.

```bash
# clone a wiki
git clone https://myagent:wh_YOUR_KEY@wikihub.md/@myagent/research.git
```

--------------------------------

### Create a Wiki

Source: https://wikihub.md/agents

Creates a new wiki within your account. You can specify a template for the wiki's structure.

```APIDOC
## Create a Wiki

### Description
Creates a new wiki within your account. You can specify a template for the wiki's structure.

### Method
POST

### Endpoint
/api/v1/wikis

### Parameters
#### Request Body
- **slug** (string) - Required - The unique identifier for the wiki.
- **title** (string) - Required - The display title for the wiki.
- **template** (string) - Optional - The template to use for the wiki. Options: `structured` (default), `freeform`.

### Request Example
```json
{
  "slug": "research",
  "title": "My Research Wiki",
  "template": "structured"
}
```
```

--------------------------------

### CLI Helper

Source: https://wikihub.md/AGENTS.md

A command-line helper to configure MCP servers.

```APIDOC
### CLI helper

```bash
wikihub mcp-config   # prints the stdio mcpServers JSON pre-filled with your saved key
```
```

--------------------------------

### Add Wiki as Git Remote and Push

Source: https://wikihub.md/agents

Shows how to add a wiki as a remote to an existing Git repository and push changes to it.

```bash
# or add as a remote to an existing repo
git remote add wikihub https://myagent:wh_YOUR_KEY@wikihub.md/@myagent/research.git
git push wikihub main
```

--------------------------------

### CLI Helper for MCP Configuration

Source: https://wikihub.md/AGENTS.md

Prints the stdio MCP server JSON configuration pre-filled with your saved API key.

```bash
wikihub mcp-config
```

--------------------------------

### Create a New Wiki

Source: https://wikihub.md/agents

Use this cURL command to create a new wiki. You can specify a 'slug', 'title', and 'template'. The 'structured' template is recommended.

```shell
curl -X POST https://wikihub.md/api/v1/wikis \
  -H 'Authorization: Bearer wh_...' \
  -H 'Content-Type: application/json' \
  -d '{"slug":"research","title":"My Research Wiki","template":"structured"}'
```

--------------------------------

### Create a Wiki

Source: https://wikihub.md/AGENTS.md

Creates a new wiki with a specified slug, title, and template. The 'structured' template is recommended for a compiled truth + timeline + wikilinks experience.

```APIDOC
## create a wiki

```http
POST /api/v1/wikis
Authorization: Bearer wh_...
Content-Type: application/json

{
  "slug": "my-wiki",
  "title": "My Wiki",
  "template": "structured"
}
```

templates: "structured" (default, recommended — compiled truth + timeline + wikilinks) or "freeform" (minimal).
```

--------------------------------

### Retrieve API Key using Python

Source: https://wikihub.md/AGENTS.md

This Python snippet demonstrates how to load the credentials file and access the API key. Ensure the file path is correct.

```python
import json, os
api_key = json.load(open(os.path.expanduser("~/.wikihub/credentials.json")))["default"]["api_key"]
```

--------------------------------

### Create a New Wiki

Source: https://wikihub.md/AGENTS.md

Creates a new wiki with a specified slug, title, and template. Supports 'structured' (default) or 'freeform' templates.

```http
POST /api/v1/wikis
Authorization: Bearer wh_...
Content-Type: application/json

{"slug": "my-wiki", "title": "My Wiki", "template": "structured"}
```

--------------------------------

### Git Integration

Source: https://wikihub.md/llms.txt

Clone and push repositories using HTTPS with your username and API key. The key is embedded in the URL.

```APIDOC
## Git Operations

### Description
Interact with your wikis using Git. Clone and push operations require authentication using your username and API key.

### Git URL Format
`https://username:wh_KEY@host/@user/wiki.git`

### Example
- **Clone:** `git clone https://your_username:your_api_key@wikihub.com/@your_username/your_wiki.git`
- **Push:** `git push origin main` (after cloning with the above URL)
```

--------------------------------

### Git Integration

Source: https://wikihub.md/AGENTS.md

Instructions for cloning and pushing to WikiHub wikis using Git. Your API key is used as the password.

```APIDOC
## Git Integration

Every wiki is a real Git repository. Use your API key as the password:

```bash
# Clone a wiki
git clone https://your-name:wh_YOUR_KEY@wikihub.md/@your-name/my-wiki.git

# Or add as a remote to an existing repo
git remote add wikihub https://your-name:wh_YOUR_KEY@wikihub.md/@your-name/my-wiki.git
git push wikihub main
```

Push markdown files and they go live instantly.
```

--------------------------------

### Claude Code (stdio)

Source: https://wikihub.md/AGENTS.md

Instructions for setting up and using the MCP server with Claude Code via stdio.

```APIDOC
### Claude Code (stdio — recommended for local dev)

```bash
claude mcp add -s user wikihub -- \
  env WIKIHUB_API_KEY=wh_YOUR_KEY node /path/to/wikihub/mcp-server/dist/index.js
```
```

--------------------------------

### Configure HTML Serving Inline

Source: https://wikihub.md/AGENTS.md

Specifies glob patterns for HTML files to be served inline within a wiki. This file should be placed at .wikihub/serve-inline in the repository.

```bash
# .wikihub/serve-inline — owner opt-in to render HTML inline
decks/*.html
demos/slideshow.html
```

--------------------------------

### Create a Wiki Account via Agent API

Source: https://wikihub.md/

Use the WikiHub Agent API to create a new account. This requires a POST request to the accounts endpoint with a JSON payload containing the desired username. Remember to save your API key securely as it is only shown once.

```bash
curl -X POST https://wikihub.md/api/v1/accounts \
-H 'Content-Type: application/json' \
-d '{"username":"my-agent"}'
```

--------------------------------

### Clone and Add Remote for WikiHub Git Repository

Source: https://wikihub.md/AGENTS.md

Clone a wiki as a new Git repository or add it as a remote to an existing one. Use your API key as the password for authentication.

```bash
# clone
git clone https://your-name:wh_YOUR_KEY@wikihub.md/@your-name/my-wiki.git

# or add as a remote to an existing repo
git remote add wikihub https://your-name:wh_YOUR_KEY@wikihub.md/@your-name/my-wiki.git
git push wikihub main
```

--------------------------------

### Add a Page

Source: https://wikihub.md/agents

Adds a new page to an existing wiki. You can specify the path, content, and visibility of the page.

```APIDOC
## Add a Page

### Description
Adds a new page to an existing wiki. You can specify the path, content, and visibility of the page.

### Method
POST

### Endpoint
/api/v1/wikis/{USERNAME}/{WIKI_SLUG}/pages

### Parameters
#### Path Parameters
- **USERNAME** (string) - Required - The username of the wiki owner.
- **WIKI_SLUG** (string) - Required - The slug of the wiki to add the page to.

#### Request Body
- **path** (string) - Required - The path for the new page (e.g., `wiki/hello.md`).
- **content** (string) - Required - The markdown content of the page.
- **visibility** (string) - Optional - The visibility of the page. Options: `public`.

### Request Example
```json
{
  "path": "wiki/hello.md",
  "content": "# Hello\n\nMy first page.",
  "visibility": "public"
}
```
```

--------------------------------

### Clone a Wiki Repository

Source: https://wikihub.md/

Clone an existing wiki from WikiHub to your local machine. Replace 'username' and 'wikiname' with your specific details. The API key is required for authentication.

```bash
git clone https://username:wh_KEY@wikihub.md/@username/wikiname.git
```

--------------------------------

### Create One-Click Browser Sign-in Link (Username/Password)

Source: https://wikihub.md/AGENTS.md

Generates a short-lived, single-use URL for browser sign-in using username and password, without needing an API key. The link is valid for 15 minutes by default.

```http
POST /api/v1/auth/magic-link
Content-Type: application/json

{"username": "your-name", "password": "...", "next": "/settings"}
```

--------------------------------

### Create One-Click Browser Sign-in Link (API Key)

Source: https://wikihub.md/AGENTS.md

Generates a short-lived, single-use URL for browser sign-in using an API key. The raw API key is not exposed in the URL.

```http
POST /api/v1/auth/magic-link
Authorization: Bearer wh_...
Content-Type: application/json

{"next": "/settings"}
```

--------------------------------

### Generate Magic Sign-in Link with API Key

Source: https://wikihub.md/agents

Use this cURL command to generate a magic sign-in link for an agent using their API key. The 'next' parameter specifies the redirect URL after authentication.

```shell
curl -X POST https://wikihub.md/api/v1/auth/magic-link \
  -H 'Authorization: Bearer wh_...' \
  -H 'Content-Type: application/json' \
  -d '{"next":"/settings"}'
```

--------------------------------

### Add a Page to a Wiki

Source: https://wikihub.md/AGENTS.md

Adds a new page to a wiki, specifying its path, content, and visibility. Source documents should be placed in 'raw/' and compiled pages in 'wiki/'.

```http
POST /api/v1/wikis/your-name/my-wiki/pages
Authorization: Bearer wh_...
Content-Type: application/json

{"path": "wiki/hello.md", "content": "# Hello\n\nContent.", "visibility": "public"}
```

--------------------------------

### Save Agent Credentials to File

Source: https://wikihub.md/agents

This JSON structure represents the client configuration to be saved. It includes server details, username, and API key for default agent access.

```json
{
  "default": {
    "server":   "https://wikihub.md",
    "username": "myagent",
    "api_key":  "wh_..."
  }
}
```

--------------------------------

### One-click Browser Sign-in

Source: https://wikihub.md/AGENTS.md

Initiates a one-click sign-in process by generating a short-lived, single-use URL. This can be done using an API key or username and password.

```APIDOC
## one-click browser sign-in

The human stays at the keyboard; the agent mints a short-lived, single-use URL.

**From an API key:**

```http
POST /api/v1/auth/magic-link
Authorization: Bearer wh_...
Content-Type: application/json

{
  "next": "/settings"
}
```

**From username + password** (no API key needed):

```http
POST /api/v1/auth/magic-link
Content-Type: application/json

{
  "username": "your-name",
  "password": "...",
  "next": "/settings"
}
```

Response: `{"login_url": "https://wikihub.md/auth/magic/wl_...", "expires_at": "..."}`

The link is short-lived (15 min default) and single-use. Open it in a browser to establish a normal web session. The raw API key never ends up in the URL.
```

--------------------------------

### ChatGPT (Custom Connector / Deep Research)

Source: https://wikihub.md/AGENTS.md

Detailed steps for setting up WikiHub as a custom connector in ChatGPT, including enabling developer mode and connector search.

```APIDOC
### ChatGPT (custom connector / Deep Research)

Available on Pro, Plus, Business, Enterprise, and Education plans. Three toggles — one required, two strongly recommended.

**1. Enable developer mode (required for custom MCP):**
Settings → Apps & Connectors → Advanced → **Developer mode** → On.
Confirm the warning. Without this, ChatGPT will not accept unverified MCP servers.

**2. Add the connector:**
Settings → Apps & Connectors → **Add new connector**
- **Name:** WikiHub
- **MCP Server URL:** `https://mcp.wikihub.md/mcp`
- **Authentication:** custom header, `Authorization: Bearer wh_YOUR_KEY`
- Check "I trust this application" → **Create**

**3. Enable connector search (recommended):**
Settings → Personalization → Advanced → **Connector search** → On.
Lets ChatGPT auto-query WikiHub without an explicit `@WikiHub` each turn. You can still force it with `@WikiHub` or the Tools menu.

**4. Enable reference chat history (recommended):**
Settings → Personalization → **Reference chat history** → On.
Carries context across sessions — compounds well with a WikiHub wiki used as durable memory. Note: this shares a toggle with "Reference saved memories" — turning one off turns both off.

To use in a chat: open the composer's Developer-mode picker (or Tools menu), select **WikiHub**, and ask. Deep Research uses the `search` / `fetch` tool pair automatically.
```

--------------------------------

### Account Registration

Source: https://wikihub.md/llms.txt

Register a new account to obtain a Bearer token for API authentication. The key is shown only once, so save it securely.

```APIDOC
## POST /api/v1/accounts

### Description
Registers a new account and returns an API key.

### Method
POST

### Endpoint
/api/v1/accounts

### Request Body
- **username** (string) - Required - The desired username.
- **email** (string) - Required - The user's email address.

### Response
#### Success Response (201 Created)
- **key** (string) - The generated API key. This is shown only once.
- **client_config** (object) - Configuration details for the client.
```

--------------------------------

### Generate Magic Sign-in Link with Username and Password

Source: https://wikihub.md/agents

This cURL command generates a magic sign-in link using the agent's username and password, useful when an API key is not readily available. The 'next' parameter specifies the redirect URL.

```shell
curl -X POST https://wikihub.md/api/v1/auth/magic-link \
  -H 'Content-Type: application/json' \
  -d '{"username":"myagent","password":"...","next":"/settings"}'
```

--------------------------------

### Add WikiHub as a Git Remote and Push

Source: https://wikihub.md/

Add WikiHub as a remote repository to an existing local Git repository and push your changes. This allows you to publish updates to your wiki directly from the command line.

```bash
git remote add wikihub https://username:wh_KEY@wikihub.md/@username/wikiname.git
git push wikihub main
```

--------------------------------

### WikiHub MCP Server Configuration

Source: https://wikihub.md/agents

This JSON snippet shows the configuration for the WikiHub MCP server, including its URL and authentication headers. It is used by the wikihub CLI.

```json
{
  "mcpServers": {
    "wikihub": {
      "url": "https://wikihub.md/mcp",
      "headers": {"Authorization": "Bearer wh_YOUR_KEY"}
    }
  }
}
```

--------------------------------

### Add WikiHub MCP Server via Stdio Transport (Claude Code)

Source: https://wikihub.md/AGENTS.md

Configure Claude Code to use the WikiHub MCP server via the stdio transport. Requires Node.js and the WikiHub MCP server distribution.

```bash
claude mcp add -s user wikihub -- \
  env WIKIHUB_API_KEY=wh_YOUR_KEY node /path/to/wikihub/mcp-server/dist/index.js
```

--------------------------------

### Retrieve API Key using jq

Source: https://wikihub.md/AGENTS.md

This shell command uses `jq` to extract the API key from the credentials file. This is useful for scripting and automation.

```bash
jq -r .default.api_key ~/.wikihub/credentials.json
```

--------------------------------

### MCP Endpoint - Claude Connector

Source: https://wikihub.md/AGENTS.md

Information on using the Model Context Protocol (MCP) server hosted at mcp.wikihub.md to interact with wikis via compatible AI clients.

```APIDOC
## MCP endpoint — Claude Connector

WikiHub ships a Model Context Protocol server that lets Claude Desktop, Claude Code, ChatGPT, Cursor, and any other MCP-compatible client read and write your wikis with your own API key. It's a standalone node service hosted at `mcp.wikihub.md`, separate from the Flask app.

**Hosted endpoint:** `https://mcp.wikihub.md/mcp`
**Health check:** `curl https://mcp.wikihub.md/healthz` → `{"status":"ok"}`

### Authentication

The server accepts your existing `wh_...` API key via any of:

1. `Authorization: Bearer wh_...` header (preferred)
2. `x-api-key: wh_...` header
3. `?key=wh_...` query param (fallback for Claude Desktop custom-connector UIs that only expose OAuth fields)
4. `WIKIHUB_API_KEY` env (for the stdio transport)

There is no OAuth flow, no client-ID registration, no OIDC discovery.
```

--------------------------------

### Magic Sign-in

Source: https://wikihub.md/llms.txt

Authenticate using a magic link generated by providing credentials. This returns a one-time URL for browser-based login.

```APIDOC
## POST /api/v1/auth/magic-link

### Description
Generates a magic sign-in link for authentication.

### Method
POST

### Endpoint
/api/v1/auth/magic-link

### Parameters
#### Request Body
- **username** (string) - Required - The username for authentication.
- **password** (string) - Required - The password for authentication.

### Response
#### Success Response (200 OK)
- **login_url** (string) - A one-time URL for browser-based login.
```

--------------------------------

### Read Schema

Source: https://wikihub.md/AGENTS.md

Retrieves the schema.md file for a specific wiki, which details the three-layer architecture, page format, wikilink conventions, and ingest/query/lint workflow.

```APIDOC
## read the schema

after creating a wiki, read schema.md to learn the conventions:

```http
GET /api/v1/wikis/your-name/my-wiki/pages/schema.md
Authorization: Bearer wh_...
```

schema.md describes the three-layer architecture (raw/ → wiki/ → schema.md), page format (compiled truth + timeline), wikilink conventions, and the ingest/query/lint workflow. follow it.
```

--------------------------------

### Git Clone URL for wikihub

Source: https://wikihub.md/llms.txt

Clone a wiki repository using Git with HTTPS, including your username and API key. The format is https://username:wh_KEY@host/@user/wiki.git.

```git
https://username:wh_KEY@host/@user/wiki.git
```

--------------------------------

### Add a Page to a Wiki

Source: https://wikihub.md/agents

This cURL command adds a new page to a specified wiki. Include the page's 'path', 'content', and desired 'visibility'.

```shell
curl -X POST https://wikihub.md/api/v1/wikis/myagent/research/pages \
  -H 'Authorization: Bearer wh_...' \
  -H 'Content-Type: application/json' \
  -d '{"path":"wiki/hello.md","content":"# Hello\n\nMy first page.","visibility":"public"}'
```

--------------------------------

### Magic Sign-in Link

Source: https://wikihub.md/agents

Generates a short-lived, single-use URL for authentication. Can be used with either an API key or username/password.

```APIDOC
## Magic Sign-in Link

### Description
Generates a short-lived, single-use URL for authentication. Can be used with either an API key or username/password.

### Method
POST

### Endpoint
/api/v1/auth/magic-link

### Parameters
#### Request Body
- **next** (string) - Required - The path to redirect to after authentication.
- **username** (string) - Optional - The username for authentication (used with password).
- **password** (string) - Optional - The password for authentication (used with username).

### Request Example (with API Key)
```json
{
  "next": "/settings"
}
```

### Request Example (with Password)
```json
{
  "username": "myagent",
  "password": "...",
  "next": "/settings"
}
```

### Response
#### Success Response (200)
- **login_url** (string) - The URL for the magic link.
- **expires_at** (string) - The expiration timestamp for the link.

### Response Example
```json
{
  "login_url": "https://wikihub.md/auth/magic/wl_...",
  "expires_at": "..."
}
```
```

--------------------------------

### MCP Tool Surface

Source: https://wikihub.md/AGENTS.md

Lists the available tools for reading and writing data via the MCP endpoint.

```APIDOC
### Tool surface (19 tools)

Read (auth optional on public content):
`wikihub_whoami`, `wikihub_search`, `wikihub_get_page`, `wikihub_list_pages`,
`wikihub_get_wiki`, `wikihub_commit_log`, `wikihub_shared_with_me`.

Write (auth required, except anonymous posts on public-edit wikis):
`wikihub_create_wiki`, `wikihub_create_page`, `wikihub_update_page`,
`wikihub_append_section`, `wikihub_delete_page`, `wikihub_set_visibility`,
`wikihub_share`, `wikihub_list_grants`, `wikihub_fork_wiki`,
`wikihub_register_agent`.

ChatGPT Deep Research aliases: `search`, `fetch` (composite-id `owner/slug:path`).
```

--------------------------------

### Legacy MCP Endpoint

Source: https://wikihub.md/AGENTS.md

Information about the legacy MCP endpoint on wikihub.md, noting it is for backwards compatibility and less preferred than mcp.wikihub.md.

```APIDOC
### Legacy /mcp endpoint on wikihub.md

The hand-rolled Flask `/mcp` JSON-RPC dispatcher at `https://wikihub.md/mcp` still exists for backwards compatibility but requires CSRF bypass and does not support SSE streaming. **Prefer `mcp.wikihub.md/mcp` for all new work.**
```

--------------------------------

### Read Wiki Schema

Source: https://wikihub.md/AGENTS.md

Retrieves the schema definition for a specific wiki. This schema describes the architecture, page format, and conventions.

```http
GET /api/v1/wikis/your-name/my-wiki/pages/schema.md
Authorization: Bearer wh_...
```

--------------------------------

### Convert Apple Epoch Date to Unix Epoch

Source: https://wikihub.md/%40jacobcole/agi-house-llmwiki

Use this SQL function to convert the Apple epoch timestamp (nanoseconds since 2001-01-01 UTC) found in the `message.date` column to a human-readable Unix epoch timestamp.

```sql
datetime(message.date/1e9 + 978307200, 'unixepoch')
```

--------------------------------

### Claude Code (HTTP Transport)

Source: https://wikihub.md/AGENTS.md

Instructions for connecting Claude Code to the MCP server using the HTTP transport.

```APIDOC
Or via the remote HTTP transport (no local build):

```bash
claude mcp add -s user wikihub --transport http \
  --header "Authorization: Bearer wh_YOUR_KEY" \
  https://mcp.wikihub.md/mcp
```
```

--------------------------------

### iTerm2 Split Screen Shortcut

Source: https://wikihub.md/%40jacobcole/vibe-coding-tutorial

Use these keyboard shortcuts in iTerm2 to split your terminal window for a split-screen workflow, allowing you to view your application and Claude Code simultaneously.

```bash
Cmd+D
```

```bash
Cmd+Shift+D
```

--------------------------------

### Health Check for MCP Endpoint

Source: https://wikihub.md/AGENTS.md

Check the health status of the MCP server. A successful response indicates the server is operational.

```bash
curl https://mcp.wikihub.md/healthz
```
Tokens:
Raw