Docs

How to install and use JameClaw

This page gives you the fast path: install the project, launch it locally, configure the basics, and run your first useful task without bouncing between external docs.

Start installation View GitHub

Install JameClaw

Use the repo path if you want to run from source, or adapt the commands for your own setup.

1

Clone the repository

Download the source code to your machine so you can build and run it locally.

2

Install dependencies

Install the frontend and any other required dependencies for the launcher experience you want to use.

3

Configure your environment

Copy the example config or environment file and add the API keys or model credentials you need.

4

Start JameClaw

Run the launcher or local dev command, then open the UI in your browser and verify the app starts correctly.

git clone https://github.com/sipeed/jameclaw.git
cd jameclaw
pnpm install
pnpm dev

Launch locally

Once the project is installed, start the local UI and open it in your browser.

Web launcher

Start the frontend, then open the local address in your browser. This is the easiest path for configuration and day-to-day use.

Standalone landing page

Use the marketing page for docs, install steps, and product messaging while the main app UI handles runtime tasks.

How to use JameClaw

After launch, the core flow is simple: configure, connect, start, and run tasks.

1

Add your model credentials

Open the models or credentials section, choose your provider, and add the API key or login method for the model you want JameClaw to use.

2

Configure a channel or tool

Set up the integrations you actually need. Keep it minimal at first so your first run is easy to debug.

3

Start the gateway

Use the start button in the UI once your configuration is valid. That turns the agent runtime on.

4

Run your first task

Give it one concrete objective such as summarizing messages, checking logs, or automating a routine workflow.

Useful commands

These examples are good starting points for local development and first-run testing.

pnpm dev
jameclaw-launcher
jameclaw-launcher -public
npx jameclaw start --task "summarize the last 20 messages"

Tips before you go deeper

A few habits make first-time setup much less painful.

Start with one model provider and one integration. Add complexity after the first successful run.
Keep your first task narrow and measurable so it is obvious whether JameClaw succeeded.
If something fails, inspect config first, then credentials, then the gateway state. That order usually saves time.
Use the landing page for install guidance and the app UI for real runtime work.