Skip to content

Server Mode ​

Server mode lets you run Chippery as a headless service, enabling remote access and integrations.

Quick Start ​

  1. Generate an auth token:

    /server-auth
  2. Enable server mode:

    /server-enable
  3. Start the server:

    /server-start

Commands ​

CommandDescription
/server-enableEnable headless server mode
/server-disableDisable headless server mode
/server-startStart the headless server
/server-stopStop the headless server
/server-statusShow server status and port
/server-authManage authentication tokens

Authentication ​

Before enabling the server, you need to create an auth token. Run /server-auth to open the token management dialog.

Creating a Token ​

  1. Run /server-auth
  2. Enter a name for your token (optional, helps you identify it later)
  3. Select permissions:
    • Read - Can read files and view content
    • Write - Can edit files and make changes
    • Execute - Can run commands and tools
  4. Select expiry (30 days, 90 days, 180 days, 1 year, or never)
  5. Click Generate

Important: The token is shown only once. Copy it immediately and store it securely.

Using Your Token ​

When connecting to the server remotely, provide your token for authentication. The exact method depends on how you're connecting (API client, integration, etc.).

Server Status ​

Check if the server is running and which port it's using:

/server-status

This shows:

  • Whether server mode is enabled
  • Whether the server is currently running
  • The port number

Typical Workflow ​

Enable and Start ​

/server-auth          # Create a token (first time only)
/server-enable        # Enable server mode
/server-start         # Start the server

Stop and Disable ​

/server-stop          # Stop the server
/server-disable       # Disable server mode

Settings ​

You can also manage server settings through the config UI:

/config

Navigate to the Server section to:

  • Enable or disable server mode
  • Configure session limits
  • Manage auth tokens