CLI Setup

Set up the Hamster CLI in a repository to sync your team’s context and deliver a Brief with your AI coding agent.

For humans

  1. Install the CLI. Run this command in your terminal:

    curl -s https://tryhamster.com/cli/install | bash
    
  2. If the installer does not open the sign-in flow, authenticate explicitly:

    hamster auth login
    
  3. Move into the repository you want to connect, then initialize it:

    hamster init
    

    This creates the .hamster/ directory, lets you select a team, and runs the first sync. Use hamster team switch later to connect the repository to a different team.

See Getting Started for authentication options and CLI Sync for ongoing sync commands.

For agents

Give your AI coding agent a Brief ID or Hamster Brief URL along with these instructions:

Set up the Hamster CLI in this repository and deliver the requested Brief. First check whether the hamster command is available. If it is not, install it by running curl -s https://tryhamster.com/cli/install | bash. Authenticate with hamster auth login if the CLI is not already signed in, then initialize this repository with hamster init. Sync the requested Brief and its project context with hamster sync <brief-id-or-url>. Read the synced Brief, Tasks, Blueprints, Methods, and repository instructions before changing code. Implement the Brief, verify its acceptance criteria, then run hamster deliver <brief-id> to complete the delivery workflow. If an interactive command needs human input, explain what is needed and wait for the user before continuing.

Replace <brief-id-or-url> with the Brief ID or full Hamster URL you were given. Replace <brief-id> with the Brief ID when starting delivery.