Skip to content

console.en.md

Latest commit

 

History

History
467 lines (314 loc) · 17.2 KB

console.en.md

File metadata and controls

467 lines (314 loc) · 17.2 KB

Console

The Console is CoPaw's built-in web interface. After running copaw app, open http://127.0.0.1:8088/ in your browser to enter the Console.

In the Console, you can:

  • Chat with CoPaw in real time
  • Enable/disable messaging channels
  • View and manage all chat sessions
  • Manage scheduled jobs
  • Edit CoPaw's persona and behavior files
  • Enable/disable skills to extend CoPaw's capabilities
  • Manage MCP clients
  • Modify runtime configuration
  • Configure LLM providers and select active models
  • Manage environment variables needed by tools
  • View LLM token usage statistics

The sidebar on the left groups features into Chat, Control, Agent, and Settings. Click any item to switch pages. The sections below walk through each feature in order.

Not seeing the Console? Make sure the frontend has been built. See CLI.

Chat

Sidebar: Chat → Chat

This is where you talk to CoPaw. It is the default page when the Console opens.

Chat

Send a message: Type in the input box at the bottom, then press Enter or click the send button (↑). CoPaw replies in real time.

Create a new session: Click the + New Chat button at the top of the chat sidebar to start a new conversation. Each session keeps separate history.

Switch sessions: Click any session name in the chat sidebar to load its history.

Delete a session: Click the ··· button on a session item, then click the trash icon.

Channels

Sidebar: Control → Channels

Manage channel for DingTalk, Feishu, Discord, QQ, iMessage, and Console.

Channels

Enable a channel:

  1. Click the channel card you want to configure.

  2. A settings panel slides out on the right. Turn on Enable.

    Channel Configuration

  3. Fill in required credentials (fields differ by channel):

    Channel Required fields
    DingTalk Client ID, Client Secret, Message Type, Card Template ID/Key, Robot Code
    Feishu App ID, App Secret, Encrypt Key, Verification Token, Media Dir
    Discord Bot Token, HTTP Proxy, Proxy Auth
    QQ App ID, Client Secret
    iMessage Database path, Poll interval
    Console (toggle only)

  4. Click Save. Changes take effect in seconds, no restart required.

Disable a channel: Open the same panel, turn off Enable, then click Save.

For credential setup details, see Channels.

Sessions

Sidebar: Control → Sessions

View, filter, and clean up chat sessions across all channels.

Sessions

Find sessions: Use the search box to filter by user, or use the dropdown to filter by channel. The table updates immediately.

Rename a session: Click Edit on a row → change the name → click Save.

Delete one session: Click Delete on a row → confirm.

Batch delete: Select rows → click Batch Delete → confirm.

Cron Jobs

Sidebar: Control → Cron Jobs

Create and manage scheduled jobs that CoPaw runs automatically by time.

Cron Jobs

Create a new job:

If the cron job fails to be created, please refer to the Troubleshooting Scheduled (Cron) Tasks section in the FAQ to identify the cause.

The simplest way to create a cron job is to chat directly with CoPaw and let it handle the creation for you. For example, if you want to receive a reminder to drink water on DingTalk, simply message CoPaw on DingTalk: "Help me create a cron job to remind me to drink water every 5 minutes." Once created, you can view the new task on the Cron Jobs page in the console.

Alternatively, you can create tasks directly via the Console interface:

  1. Click + Create Job.

    Create Cron Job

  2. Fill in each section:

    • Basic Info — Job ID (e.g. job-001) and job name (e.g. "Daily Summary").
    • Schedule — Cron expression (e.g. 0 9 * * * = 9:00 AM daily) and timezone (defaults to your configured user timezone)
    • Task Type & Content — Text (fixed message) or Agent (ask CoPaw and forward reply), then the content
    • Delivery — Target channel (Console, DingTalk, etc.), target user & session id, and mode (Stream = real-time, Final = one complete response)
    • Advanced — Max concurrency, timeout, misfire grace time

  3. Click Save.

Edit a job: Click Edit on a row → modify fields → Save.

Enable/disable a job: Toggle the switch in the row.

Run once immediately: Click Execute Now → confirm.

Delete a job: Click Delete → confirm.

Workspace

Sidebar: Agent → Workspace

Edit files that define CoPaw's persona and behavior, such as SOUL.md, AGENTS.md, and HEARTBEAT.md, directly in the browser.

Multi-Agent Workspace: Starting from v0.1.0, CoPaw supports multi-agent workspace functionality. You can run multiple independent agents in a single CoPaw instance, each with its own workspace, configuration, memory, and conversation history. Use the agent switcher at the top of the console to change the active agent. See Multi-Agent Workspace for details.

Workspace

Edit files:

  1. Click a file in the list (e.g. SOUL.md).
  2. The editor shows file content. Make your changes.
  3. Click Save to apply, or Reset to discard and reload.

View daily memory: If MEMORY.md exists, click the ▶ arrow to expand date-based entries. Click a date to view or edit that day's memory.

Download workspace: Click Download (⬇) to export the entire workspace as a .zip.

Upload/restore workspace: Click Upload (⬆) → choose a .zip (max 100 MB). Existing workspace files will be replaced. Useful for migration and backup restore.

Skills

Sidebar: Agent → Skills

Manage skills that extend CoPaw's capabilities (for example: PDF reading, Word document creation, news retrieval).

Skills

Enable a skill: Click Enable at the bottom of a skill card. It takes effect immediately.

View skill details: Click a skill card to open its full description.

Disable a skill: Click Disable. It also takes effect immediately.

Import from Skill Hub:

  1. Click Import Skill.
  2. Enter a skill URL, then click import.
  3. Wait for import to complete. The skill appears as enabled.

Import Skill

Create a custom skill:

  1. Click Create Skill.
  2. Enter a skill name (e.g. weather_query) and skill content in Markdown (must include name and description).
  3. Click Save. The new skill appears immediately.

Create Skill

Delete a custom skill: Disable the skill first, then click the 🗑 icon on its card and confirm.

For built-in skill details, Skill Hub import, and custom skill authoring, see Skills.

MCP

Sidebar: Agent → MCP

Enable/disable/delete MCP clients here, or create new ones.

MCP

Create a client Click Create Client in the top-right, fill in the required information, then click Create. The new MCP client appears in the list.

Runtime Config

Sidebar: Agent → Runtime Config

Runtime Config

Adjust Max iterations and Max input length here; click Save after changing.

Models

Sidebar: Settings → Models

Configure LLM providers and choose the model CoPaw uses. CoPaw supports both cloud providers (API key required) and local providers (no API key required).

Models

Cloud providers

Configure a provider:

  1. Click Settings on a provider card (ModelScope, DashScope).
  2. Enter your API Key.
  3. Click Save. Card status becomes "Authorized".
  4. To add a custom provider, click Add Provider.
  5. Enter provider ID, display name, and required fields, then click Create.
  6. Open Settings for the created provider, fill required fields, then Save. Status becomes "Authorized".

Revoke authorization: Open the provider settings dialog and click Revoke Authorization. API key data is cleared. If this provider is currently active, model selection is also cleared.

Local providers (llama.cpp / MLX)

Local providers show a purple Local tag. Install backend dependencies first (pip install 'copaw[llamacpp]' or pip install 'copaw[mlx]').

Download a model:

  1. Click Manage Models on a local provider card.
  2. Click Download Model, then fill:
    • Repo ID (required) — e.g. Qwen/Qwen3-4B-GGUF
    • Filename (optional) — leave empty for auto-selection
    • Source — Hugging Face (default) or ModelScope
  3. Click Download and wait for completion.

View and delete models: Downloaded models are listed with file size, source badge (HF / MS), and delete button.

Ollama provider

The Ollama provider integrates with your local Ollama daemon and dynamically loads models from it.

Prerequisites:

  • Install Ollama from ollama.com
  • Install the Ollama SDK: pip install 'copaw[ollama]' (or re-run the installer with --extras ollama)

Download a model:

  1. Click Settings on the Ollama provider card.
  2. In API Key, enter a value (for example ollama), then click Save.
  3. Click Manage Models on the Ollama card, click Download Model, and enter a model name (e.g. mistral:7b, qwen3:8b).
  4. Click Download Model and wait for completion.

Cancel a download: During download, click ✕ next to the progress indicator to cancel.

View and delete models: Downloaded models are listed with size and delete button. The list updates automatically when models are added/removed via Ollama CLI or Console.

How it differs from local providers:

  • Models come from the Ollama daemon (not downloaded directly by CoPaw)
  • Model list is auto-synced with Ollama
  • Popular model examples: mistral:7b, qwen3:8b

You can also manage Ollama models via CLI: copaw models ollama-pull, copaw models ollama-list, copaw models ollama-remove. See CLI.

⚠️ Before running CoPaw, you must set the context length to 32K or higher

To run CoPaw properly, you must set the model context length to 32K or higher. Note that this can consume substantial compute resources, so make sure your local machine can handle it.

Ollama context length configuration

LM Studio provider

The LM Studio provider connects to the LM Studio desktop application's OpenAI-compatible local server to discover and use loaded models.

Prerequisites:

  • Install LM Studio from lmstudio.ai
  • Load a model and start the local server in LM Studio (default: http://localhost:1234)

Configure:

  1. Click Settings on the LM Studio provider card.
  2. The default Base URL is http://localhost:1234/v1. Adjust if needed, then click Save.
  3. Click Manage Models to see models loaded in LM Studio. You can also manually add model IDs.
  4. Select LM Studio in the Provider dropdown and pick a model.

LM Studio does not require an API key by default. Models must be loaded in LM Studio before they appear in CoPaw.

⚠️ Before running CoPaw, you must set the context length to 32K or higher

To run CoPaw properly, you must set the model context length to 32K or higher. Note that this can consume substantial compute resources, so make sure your local machine can handle it.

LM Studio context length configuration

Choose the active model

  1. In the LLM Config section, select a Provider from the dropdown (only authorized providers or local providers with downloaded models appear).
  2. Select a Model from the model dropdown.
  3. Click Save.

Note: Cloud API key validity is your responsibility. CoPaw does not verify key correctness.

For provider details, see Config — LLM Providers.

Environment Variables

Sidebar: Settings → Environment Variables

Manage runtime environment variables needed by CoPaw tools and skills (for example, TAVILY_API_KEY).

Environments

Add a variable:

  1. Click + Add Variable.
  2. Enter the variable name (e.g. TAVILY_API_KEY) and value.
  3. Click Save.

Edit a variable: Change the Value field, then click Save. (Variable names are read-only after save; to rename, delete and recreate.)

Delete a variable: Click the 🗑 icon on a row, then confirm if prompted.

Batch delete: Select rows → click Delete in the toolbar → confirm.

Note: Variable validity is your responsibility. CoPaw only stores and loads values.

See Config — Environment Variables for more.

Token Usage

Sidebar: Settings → Token Usage

View LLM token consumption over a time range, aggregated by date and model.

View usage:

  1. Select a date range (default: last 30 days).
  2. Click Refresh to fetch data.
  3. The page shows total tokens, total calls, and breakdowns by model and date.

Query via chat:

Ask CoPaw directly, e.g. "How many tokens have I used recently?" or "Show me token usage." The agent will call the get_token_usage tool and return the summary.

Data is stored in ~/.copaw/token_usage.json. You can override the filename with the COPAW_TOKEN_USAGE_FILE environment variable. See Config — Environment Variables.

Quick Reference

Page Sidebar path What you can do
Chat Chat → Chat Talk with CoPaw, manage sessions
Channels Control → Channels Enable/disable channels, configure credentials
Sessions Control → Sessions Filter, rename, delete sessions
Cron Jobs Control → Cron Jobs Create/edit/delete jobs, run immediately
Workspace Agent → Workspace Edit persona files, view memory, upload/download
Skills Agent → Skills Enable/disable/create/delete skills
MCP Agent → MCP Enable/disable/create/delete MCP clients
Runtime Config Agent → Runtime Config Modify runtime configuration
Models Settings → Models Configure providers, manage local/Ollama/LM Studio, pick model
Environment Variables Settings → Environment Variables Add/edit/delete environment variables
Token Usage Settings → Token Usage View LLM token usage by date and model

Related Pages