Skip to main content

Install and Get Started

Install​

Download the desktop app or CLI package for your operating system and processor from the CSGClaw releases. For the CLI, the installers support macOS arm64, Linux amd64 and arm64, and Windows amd64. For macOS amd64, check the prebuilt packages. From a source checkout, run make build at the repository root. See the build guide.

Check the CLI installation with csgclaw --version. If the command is unavailable, reopen your terminal and check that the installation directory is on your PATH.

Open the workspace​

Open the desktop app, or run csgclaw serve and open the URL printed in the terminal. Add --browser to open the browser automatically. The first startup initializes missing local settings and creates the workspace.

For a hosted workspace, see Use CSGClaw in AgenticHub.

Connect a model​

  1. Open Settings → Model Services and connect OpenCSG or a third-party provider. Follow the provider prompts to sign in or enter its key.
  2. Confirm that the model appears in the list. Choose a default chat model for new agents. Open the existing Manager's settings to check its model.
  3. Check available runtimes in Settings → Runtime Environment. Use a separate workspace directory for the first task and choose read-only mode if your conversation supports it.

Complete your first task​

Select New Task and choose Manager or an agent with a working model. Ask the agent to draft a release checklist with owners and acceptance criteria directly in the chat. Once you have the result, ask it to add rollback criteria in the same conversation.

Stop or upgrade​

Press Ctrl+C to stop a foreground service. For a background service started with csgclaw serve --daemon, run csgclaw stop. Closing the browser leaves the local service running.

Before upgrading, check the release notes and the runtime migration guide. After upgrading, verify your workspace, model configuration, and existing agents with a test task.