Qoder

https://docs.qoder.com/
Admin
Qoder is an agentic coding platform that integrates enhanced context engineering with intelligent...
Tokens:1,591,760
Snippets:10,733
Trust Score:8.1
Update:1 day ago
Show doc for...
Tokens:
Raw
### Environment setup script JSON example

Source: https://docs.qoder.com/cloud-agents/api/forward/environments/schemas

Shows a `config` object with `type` set to `"cloud"` and a `setup_script` that clones a repository if needed and installs dependencies with pnpm. The script runs after `packages` installation and must be a string up to 64 KB.

```json
{
  "config": {
    "type": "cloud",
    "setup_script": "set -euo pipefail\n[ -d /workspace/.git ] || git clone https://github.com/me/repo /workspace\ncd /workspace && pnpm install --frozen-lockfile"
  }
}
```

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

### Create environment with packages and setup script

Source: https://docs.qoder.com/cloud-agents/api/forward/environments/create

Creates a cloud environment with an npm package (pnpm@9) and a setup script that clones a repository and installs dependencies. The setup script uses 'set -euo pipefail' and runs pnpm install with --frozen-lockfile.

```bash
curl -sS --fail-with-body \
  -X POST "https://api.qoder.com/api/v1/forward/environments" \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "doc-test-env-with-setup",
    "config": {
      "type": "cloud",
      "packages": {
        "npm": ["pnpm@9"]
      },
      "setup_script": "set -euo pipefail\n[ -d /workspace/.git ] || git clone https://github.com/me/repo /workspace\ncd /workspace && pnpm install --frozen-lockfile"
    }
  }'
```

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

### From zero to ready: environment setup, login, start, status, portal

Source: https://docs.qoder.com/qoderwake/cli-reference

Sets up the daily environment (optional for prod), logs in via browser, starts the daemon, confirms it's online, and opens the Console.

```bash
export QODER_ENV=daily          # Daily environment (can be omitted for prod)
qoderwake login                 # Browser login
qoderwake start                 # Bring up the daemon
qoderwake status                # Confirm it's online
qoderwake portal                # Open the Console
```

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

### Install extra software with config.packages

Source: https://docs.qoder.com/cloud-agents/container-reference

Example configuration for installing extra software in a managed cloud environment using config.packages fields: apt, pip, and npm. The setup_script runs after package installation.

```json
{
  "config": {
    "type": "cloud",
    "packages": {
      "apt": ["postgresql-client", "redis-tools"],
      "pip": ["pandas==2.2.3"],
      "npm": ["typescript@5.8.3"]
    }
  }
}
```

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

### Prompt to check Node.js installation

Source: https://docs.qoder.com/user-guide/chat/model-context-protocol

Example prompt to ask Qoder IDE to verify that Node.js is installed, a prerequisite for the local STDIO MCP server.

```text
Check my local environment to ensure Node.js is installed
```

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

### Product user documentation prompt

Source: https://docs.qoder.com/qoderwork/writing

Prompt template for writing a developer integration guide from an API spec. References @api-spec.yaml and requests overview, authentication, quick start with cURL examples, endpoint reference, error code table, and FAQ, with Stripe docs as style reference.

```markdown
@api-spec.yaml
Based on this API spec, write a developer integration guide.
Include: overview, authentication, quick start (cURL examples),
core endpoint reference (request/response examples), error code
table, and FAQ.
Style reference: Stripe docs — concise, example-driven.
```

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

### Start demo on Windows

Source: https://docs.qoder.com/qoderwake/github-devops

Run the start-demo.cmd script from the extracted demo directory on Windows. Requires Node.js 20+, Git, GitHub CLI, a running QoderWake instance, and a GitHub account with appropriate permissions.

```batch
.\start-demo.cmd
```

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

### Start demo on macOS or Linux

Source: https://docs.qoder.com/qoderwake/github-devops

Run the start-demo script from the extracted demo directory on macOS or Linux. Requires Node.js 20+, Git, GitHub CLI, a running QoderWake instance, and a GitHub account with appropriate permissions.

```bash
./start-demo
```

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

### Environment Configuration Example

Source: https://docs.qoder.com/cloud-agents/api/forward/environments/schemas

Example of a cloud environment configuration using setup_script.

```APIDOC
## Environment Configuration

### Description
Example of a cloud environment configuration with a setup script.

### Fields
- **config** (object) - Required - The environment configuration object.
  - **type** (string) - Required - Must be `"cloud"`.
  - **setup_script** (string) - Optional - Shell script run during sandbox preparation after packages installation.

### Example
```json
{
  "config": {
    "type": "cloud",
    "setup_script": "set -euo pipefail\n[ -d /workspace/.git ] || git clone https://github.com/me/repo /workspace\ncd /workspace && pnpm install --frozen-lockfile"
  }
}
```
```

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

### Example request: curl GET file

Source: https://docs.qoder.com/cloud-agents/api/forward/files/get

Sends a GET request to retrieve a file by ID. Requires an access token in the Authorization header.

```bash
curl -X GET "https://api.qoder.com/api/v1/forward/files/file_xxx" \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"
```

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

### End-to-End Quickstart Script (bash)

Source: https://docs.qoder.com/cloud-agents/quickstart

Runs the full Qoder Cloud Agents flow: fetch or create an environment, get or create an agent, create a session, send a message, and stream events. Requires QODER_ACCESS_TOKEN to be set; optionally override QODER_API_BASE_URL. Press Ctrl+C to stop the event stream.

```bash
#!/bin/bash
# Qoder Cloud Agents quickstart script
# Usage: export QODER_ACCESS_TOKEN="your-token" && bash quickstart.sh
set -euo pipefail

QODER_API_BASE_URL="${QODER_API_BASE_URL:-https://api.qoder.com}"
BASE_URL="$QODER_API_BASE_URL/api/v1/cloud"
HEADERS=(
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"
)

echo "=== Step 1: Fetch environment ==="
ENV_ID=$(curl -s "$BASE_URL/environments" "${HEADERS[@]}" | jq -r '.data[0].id')
if [ "$ENV_ID" = "null" ] || [ -z "$ENV_ID" ]; then
  echo "No environment found. Creating a default one..."
  ENV_ID=$(curl -s -X POST "$BASE_URL/environments" \
    "${HEADERS[@]}" \
    -H "Content-Type: application/json" \
    -d '{"name":"default"}' | jq -r '.id')
fi
echo "Environment ID: $ENV_ID"

echo "=== Step 2: Get or create the Agent ==="
AGENT_ID=$(curl -s "$BASE_URL/agents" "${HEADERS[@]}" | jq -r '.data[0].id')
if [ "$AGENT_ID" = "null" ] || [ -z "$AGENT_ID" ]; then
  AGENT_ID=$(curl -s -X POST "$BASE_URL/agents" \
    "${HEADERS[@]}" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "quickstart-agent",
      "model": "ultimate",
      "system": "You are an efficient programming assistant.",
      "tools": [{"type": "agent_toolset_20260401", "enabled_tools": ["Bash", "Read", "Write", "Edit", "Glob", "Grep", "WebFetch", "WebSearch"]}]
    }' | jq -r '.id')
fi
echo "Agent ID: $AGENT_ID"

echo "=== Step 3: Create the Session ==="
SESSION_ID=$(curl -s -X POST "$BASE_URL/sessions" \
  "${HEADERS[@]}" \
  -H "Content-Type: application/json" \
  -d "{\"agent\": \"$AGENT_ID\", \"environment_id\": \"$ENV_ID\"}" | jq -r '.id')
echo "Session ID: $SESSION_ID"

echo "=== Step 4: Send a message ==="
curl -s -X POST "$BASE_URL/sessions/$SESSION_ID/events" \
  "${HEADERS[@]}" \
  -H "Content-Type: application/json" \
  -d '{
    "events": [
      {"type": "user.message", "content": [{"type": "text", "text": "Print Hello World and tell me the current system time."}]}
    ]
  }' | jq .

echo "=== Step 5: Stream events ==="
echo "(Press Ctrl+C to exit)"
curl -s -N "$BASE_URL/sessions/$SESSION_ID/events/stream" "${HEADERS[@]}"
```

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

### Example request: curl GET environment

Source: https://docs.qoder.com/cloud-agents/api/forward/environments/get

Sends a GET request to retrieve an environment by its ID. Requires a valid QODER_ACCESS_TOKEN in the Authorization header.

```bash
curl -X GET "https://api.qoder.com/api/v1/forward/environments/env_xxx" \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"
```

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

### Create environment with setup script (curl)

Source: https://docs.qoder.com/cloud-agents/api/environments/create

Sends a POST request to create a cloud environment. The setup_script clones a repository and runs pnpm install. Requires a Qoder access token in the Authorization header.

```bash
curl -s -X POST 'https://api.qoder.com/api/v1/cloud/environments' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "doc-test-env-with-setup",
    "config": {
      "type": "cloud",
      "packages": {
        "npm": ["pnpm@9"]
      },
      "setup_script": "set -euo pipefail\n[ -d /data/workspace/repo/.git ] || git clone https://github.com/me/repo /data/workspace/repo\ncd /data/workspace/repo && pnpm install --frozen-lockfile"
    }
  }'
```

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

### Get member details - Active member response

Source: https://docs.qoder.com/account/teams/openapi/members

Example success response for an active member when calling GET /v1/organizations/{organization_id}/members/{member_id}.

```json
{
  "id": "member_abc123",
  "userId": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Alice",
  "email": "alice@example.com",
  "role": "org_admin",
  "status": "ENABLED",
  "joinedAt": "2025-06-01T08:00:00Z"
}
```

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

### Complete Example (TypeScript)

Source: https://docs.qoder.com/cli/sdk/mcp

Full example of creating an MCP server with the Qoder Agent SDK. It defines a business tool, assembles the server, starts a query, handles authentication, and consumes messages. Note the use of AsyncIterable for user messages and the manual OAuth callback handling.

```TypeScript
import { query, createSdkMcpServer, tool } from '@qoder-ai/qoder-agent-sdk';
import { z } from 'zod';

// 1. Define business tools
const getUserOrders = tool(
  'get_user_orders',
  'Query a user\'s orders, optionally filtered by status.',
  {
    userId: z.string().describe('User UUID'),
    status: z.enum(['pending', 'paid', 'shipped', 'cancelled']).optional()
      .describe('Filter by order status'),
  },
  async ({ userId, status }) => {
    try {
      const orders = await db.getOrders(userId, status);
      return { content: [{ type: 'text', text: JSON.stringify(orders) }] };
    } catch (err) {
      return {
        isError: true,
        content: [{ type: 'text', text: `Query failed: ${(err as Error).message}` }],
      };
    }
  },
  { annotations: { readOnlyHint: true } },
);

// 2. Assemble the server
const myServer = createSdkMcpServer({
  name: 'crm',
  tools: [getUserOrders /* , ... */],
});

// 3. Start query (use AsyncIterable so no message is sent yet)
async function* userMessages() {
  yield {
    type: 'user' as const,
    message: { role: 'user' as const, content: 'List the recently paid orders for user-123' },
    parent_tool_use_id: null,
  };
}

const q = query({
  prompt: userMessages(),
  options: {
    mcpServers: {
      crm: myServer,
      // Assume a remote server that uses CLI-driven OAuth (GitHub MCP uses elicit-URL, not this path)
      analytics: { type: 'http', url: 'https://analytics.example.com/mcp' },
    },
    allowedTools: ['mcp__crm__get_user_orders'],
    controlRequestTimeoutMs: 30_000,
  },
});

// 4. Wait for handshake; actively drive auth before the first user message
await q.initializationResult();
const status = await q.mcpServerStatus();
for (const s of status.filter((x) => x.status === 'needs-auth')) {
  const result = await q.mcpAuthenticate(s.name);
  if (result.requiresUserAction) {
    const callbackUrl = await openInBrowserAndWaitForCallback(result.authUrl!);
    await q.mcpSubmitOAuthCallbackUrl(s.name, callbackUrl);
  }
  // Silent refresh success: requiresUserAction === false; no UI required
}

// 5. Consume messages (tools list is now stable; prompt prefix cache will be established correctly)
for await (const msg of q) {
  if (msg.type === 'result') {
    console.log(msg.subtype === 'success' ? msg.result : msg);
    break;
  }
}

await q.close?.();
```

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

### QoderSDKClient instantiation and connection

Source: https://docs.qoder.com/cli/sdk/references-python

Shows how to create a QoderSDKClient with options and connect with an initial prompt. Suitable for multi-turn conversations that need to maintain session state.

```python
client = QoderSDKClient(options=options)
await client.connect("Initial prompt.")
```

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

### Self-hosted environment config example

Source: https://docs.qoder.com/cloud-agents/api/environments/schemas

Example of a self_hosted environment config containing only the type and an optional setup_script. The setup_script is a string that specifies a user setup script.

```json
{"type": "self_hosted", "setup_script": "./initialize-worker.sh"}
```

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

### Install Node.js with Homebrew (macOS)

Source: https://docs.qoder.com/troubleshooting/mcp-common-issue

Update Homebrew, install Node.js, verify versions, and optionally configure environment variables. The PATH export example uses node@16, which may need adjustment for your installed version.

```bash
# 1. Update Homebrew and install Node.js.
brew update
brew install node

# 2. Verify installation and confirm the versions.
echo "Node.js version: $(node -v)"
echo "npm version: $(npm -v)"
echo "npx version: $(npx -v)"

# 3. Configure environment variables (if necessary).
echo 'export PATH="/usr/local/opt/node@16/bin:$PATH"' >> ~/.zshrc
```

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

### Example response: HTTP 200 OK for GET /api/v1/cloud/models

Source: https://docs.qoder.com/cloud-agents/api/models/list

Example JSON response showing a model object with fields like id, display_name, price_factor, and available_context_windows.

```json
{
  "data": [
    {
      "id": "ultimate",
      "type": "model",
      "display_name": "Ultimate",
      "source": "system",
      "is_enabled": true,
      "is_new": false,
      "price_factor": 1.6,
      "efforts": ["low", "medium", "high", "xhigh", "max"],
      "default_effort": "high",
      "max_input_tokens": 1000000,
      "default_context_window": 200000,
      "available_context_windows": [200000, 400000, 1000000]
    }
  ],
  "has_more": false
}
```

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

### qoderwake start [options]

Source: https://docs.qoder.com/qoderwake/cli-reference

Starts the QoderWake daemon. Options include --host, --port (default 19820, CN region 19830), --foreground, --open, --no-keepalive, --mock, and -y/--yes. The daemon must be running before most commands.

```bash
qoderwake start [options]
```

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

### Create environment with setup script using curl

Source: https://docs.qoder.com/cloud-agents/environments

Creates a cloud environment that clones a repository and warms its dependency cache. The setup_script runs through /bin/bash -lc during sandbox preparation after packages are installed. It has a max length of 64 KB and a timeout of 10 minutes. On success a completion marker is written so the script does not run twice in the same sandbox; a non-zero exit aborts session startup and the error response includes the exit code and a stderr excerpt.

```bash
# Create an environment that clones the project and warms its dependency cache
curl -s -X POST https://api.qoder.com/api/v1/cloud/environments \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "node-with-init",
    "config": {
      "type": "cloud",
      "packages": {
        "npm": ["pnpm@9"]
      },
      "setup_script": "set -euo pipefail\n[ -d /data/workspace/repo/.git ] || git clone https://github.com/me/repo /data/workspace/repo\ncd /data/workspace/repo && pnpm install --frozen-lockfile"
    }
  }' | jq .
```

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

### Example response for creating a Session

Source: https://docs.qoder.com/cloud-agents/quickstart

Example JSON response from the create Session request, showing the session object with agent, environment_id, status, and timestamps. The session starts in idle status.

```json
{
  "id": "sess_019e451b146470cda02c560bf019fb37",
  "type": "session",
  "agent": {
    "id": "agent_019e451902fe7a2ca42c2dfc62d9320e",
    "type": "agent",
    "name": "my-first-agent",
    "model": {"id": "ultimate", "effective_context_window": 200000},
    "version": 1
  },
  "environment_id": "env_019e44eb66bb748cabcd1489f6fa4428",
  "status": "idle",
  "title": null,
  "metadata": {},
  "resources": [],
  "vault_ids": [],
  "deployment_id": null,
  "outcome_evaluations": [],
  "stats": {"active_seconds": 0, "duration_seconds": 0},
  "environment_variables": {},
  "archived_at": null,
  "created_at": "2026-05-18T10:01:00Z",
  "updated_at": "2026-05-18T10:01:00Z"
}
```

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

### Enter Plan mode at startup with --permission-mode plan

Source: https://docs.qoder.com/cli/plan-mode

Start Qoder in Plan working state using the --permission-mode plan flag. This flag is retained for backward compatibility and maps to 'default permission mode + enter Plan state'.

```bash
qoder --permission-mode plan
```

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

### Tasks to start technical investigations in parallel

Source: https://docs.qoder.com/qoderwake/at-waker-im-best-practices

Two example tasks for starting parallel investigations. The first routes to Engineering Investigator, the second to Operations Analyst. Both are sent to the same Incident Bot.

```text
Engineering lead: @IncidentBot New task: Compare the latest release with the stack trace. Return evidence and remediation options only.

Incident lead: @IncidentBot New task: Inspect monitoring and logs. Return a recovery plan, risks, and observation signals. Do not execute it.
```

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

### Get member details - Deleted member response

Source: https://docs.qoder.com/account/teams/openapi/members

Example success response for a deleted member when calling GET /v1/organizations/{organization_id}/members/{member_id}. The GetMember endpoint automatically includes deleted members.

```json
{
  "id": "member_def456",
  "userId": "550e8400-e29b-41d4-a716-446655440002",
  "name": "Bob",
  "email": "bob@example.com",
  "role": "org_member",
  "status": "DELETED",
  "joinedAt": "2025-03-15T10:00:00Z",
  "deletedAt": "2026-02-01T12:00:00Z"
}
```

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

### Manually start Qoder IDE executable paths

Source: https://docs.qoder.com/troubleshooting/common-issue

Navigate to the Qoder IDE executable directory and run the start command. Paths are provided for Windows and macOS.

```text
Windows：C:\Users\Username\AppData\Local\Programs\Qoder\resources\app\resources\bin$version`CPU_architecture_64_system`\Qoder.exe

Mac：/Applications/Qoder.app/Contents/Resources/app/resources\bin$versionCPU_ahicture_64_system\Qoder
```

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

### GET /api/v1/forward/channel_pairings request

Source: https://docs.qoder.com/cloud-agents/api/forward/channels/list-channel-pairings

Example request to list channel pairings with optional filters for channel_id, status, and target_type.

```http
GET /api/v1/forward/channel_pairings?channel_id=channel_019eabc123&status=pairing&target_type=group
```

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

### Ask Qoder to outline project architecture

Source: https://docs.qoder.com/cli/quickstart

Start with an exploratory question to let Qoder understand the project. Qoder will autonomously search and read relevant files, providing explanations with file locations. It is recommended to enter `/init` to generate an `AGENTS.md` memory file.

```text
Help me outline the overall architecture and main modules of this project
```

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

### Install Qoder CLI on Windows via CMD

Source: https://docs.qoder.com/cli/installation

Recommended installation method for Windows Command Prompt. Downloads the installation script and runs it.

```cmd
curl -fsSL https://qoder.com/install.cmd -o install.cmd && install.cmd
```
Tokens:
Raw