Skip to main content

Command Line, APIs, and Reference

Command line​

Use csgclaw to manage the local service and its objects. Use csgclaw-cli for supported workflows against a running service, including participant and channel operations. Run either command with --help, then check the relevant subcommand's help for your version.

TaskCommand or command group
Check the version, run or stop the server, or check updates--version, serve, stop, upgrade
Inspect agents and modelsagent, model
Manage identities, rooms, members, or messagesparticipant, user, room, member, message
Manage team tasks and schedulesteam, task, scheduled-task
Manage templates, skills, and connectorstemplate, skill, app

Use the actual service URL and the authentication options supported by your installation. For available flags and permissions, see the CLI reference.

APIs and integration​

Use the service URL for your deployment. Where authentication is enabled, supply the required Bearer token when calling protected routes.

TaskReference
Manage agents, rooms, participants, messages, and attachmentsHTTP API reference
Send input to an agent and stream responses from your applicationThird-party client integration
Connect tools or knowledge basesMCP configuration
Receive external messages or connect FeishuScheduling and Message Integrations

Local configuration​

For the listening address, access token, and startup settings, see the configuration reference. Manage model providers in the workspace. Before upgrading an older runtime, follow the migration instructions.