Skip to content
Book a demo

Quickstart

Install the CLI, pair it with your account, set up a pod and project, create an agent, and send your first message.

1. Install the CLI

Terminal window
npm install -g @renai-labs/cli

Verify the install:

Terminal window
ren --version

For full install options (including Homebrew and manual binary), see Install the CLI.

2. Pair with your account

Terminal window
ren init

The CLI opens a browser to authenticate. Approve the pairing request, then return to your terminal.

Confirm you’re paired:

Terminal window
ren whoami

You should see your account details printed.

3. Find or create a pod

A pod is the compute environment where your agents run.

Check if you already have one:

Terminal window
ren pods list

If a pod appears, note its ID and skip ahead to step 4.

If the list is empty, create one:

Terminal window
ren pods create --name "My Pod"

Note the podId from the output. You’ll need it next.

4. Create a project

A project groups agents and their sessions inside a pod.

Terminal window
ren projects create --pod-id <podId> --name "Onboarding"

Replace <podId> with the ID from step 3. Note the projectId from the output.

5. Create an agent and add it to the project

An agent is the AI worker that carries out tasks.

Create the agent:

Terminal window
ren agents create --name "My Agent" --icon "🤖"

Note the agentId from the output.

List the available models and copy an id:

Terminal window
ren models list

Create a version with a system prompt and one of those model ids:

Terminal window
ren agents versions create <agentId> --prompt "You are a helpful assistant." --model <model-id>

Add the agent to your project:

Terminal window
ren projects agents add <projectId> --agent-id <agentId>

6. Start a session and open it

Create a session against your pod and project:

Terminal window
ren sessions create --pod-id <podId> --project-id <projectId> --title "First chat"

Note the session id from the output, then get its connection URL:

Terminal window
ren sessions url <sessionId>

Open that URL in your browser to chat with your agent. That’s your first session running on Ren.

To drive sessions from your own code instead, see the TypeScript SDK.