Jam

https://jam.dev/docs
Admin
Jam helps customer support, product, and engineering teams capture and debug issues faster by...
Tokens:82,709
Snippets:735
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### jam skills install

Source: https://jam.dev/docs/cli-reference

Installs a skill stub that loads from `jam skills get` into an agent's directory, or into `<dir>/<name>/SKILL.md`.

```APIDOC
## jam skills install

### Description
Installs a skill stub that loads from `jam skills get` into an agent's directory, or into `<dir>/<name>/SKILL.md`.

### Command
`jam skills install [name] [--target <agent>] [--project] [--dir <dir>]`

### Parameters
#### Arguments
- **name** (string) - Optional - Name of the skill to install.

#### Options
- **--target** (string) - Optional - Target agent.
- **--project** (boolean) - Optional - Install into project.
- **--dir** (string) - Optional - Directory to install into.

### Output
Receipt
```

--------------------------------

### Angular: Install @jam.dev/recording-links package

Source: https://jam.dev/docs/custom-recording-domain

Install the package before initializing the SDK. This is a prerequisite for the Angular initialization snippet.

```bash
npm install @jam.dev/recording-links
```

--------------------------------

### Compact event output example

Source: https://jam.dev/docs/cli-reference

Example output of the event commands (get console, get network, get user-events, get events) in compact text mode. Each line shows time into the recording, kind, and detail. Failed requests or console errors include the reason: error message or source file and line.

```text
events[2]{atMs,kind,detail}:
  4101,network.server,POST 502 422ms https://api.example.com/pay → Payment provider timed out
  4180,console.error,Checkout failed {"code":502} (at https://app.example.com/assets/checkout.js:12)

```

--------------------------------

### Start and stop a screen recording with jam record start and stop

Source: https://jam.dev/docs/cli-reference

Starts a screen recording without wrapping a command, checks its status, then stops it. Use when the steps run in the same process that calls the CLI, such as a coding agent or a shell script. `start` returns as soon as the first frame is captured; `stop` uploads the video and prints the Jam link.

```bash
jam record start --app "Google Chrome" --title "Checkout completes"
jam record status
# drive the app: open the page, add to cart, pay
jam record stop

```

--------------------------------

### Install Jam SDK with npm or yarn

Source: https://jam.dev/docs/custom-logs

Install the Jam SDK using either npm or yarn. Choose the command that matches your package manager.

```bash
npm install '@jam.dev/sdk'

```

```bash
yarn add '@jam.dev/sdk'

```

--------------------------------

### Record agent-browser session with jam record start

Source: https://jam.dev/docs/cli-record-browser

Drive Chrome with agent-browser while recording through the proxy. Launch headless Chrome, get its CDP URL, start a recording with jam record start, then use a second agent-browser session to open the target page through the proxy. Stop the recording with jam record stop. If the session that launched Chrome connects elsewhere, agent-browser closes that Chrome and the recording loses its browser.

```bash
agent-browser open about:blank                                                   # session A launches headless Chrome
agent-browser get cdp-url                                                        # → ws://127.0.0.1:<port>/devtools/browser/…
jam record start --cdp <cdp-url> --title "Checkout completes" --json             # → { session, cdpProxy }
agent-browser --session jam --cdp <cdpProxy> open https://example.com/checkout   # a second session drives through the proxy
jam record stop <session> --json

```

--------------------------------

### Install Jam CLI on Windows

Source: https://jam.dev/docs/cli-reference

Installs the Jam CLI on Windows via PowerShell. The script downloads the binary to %LOCALAPPDATA%\Programs\Jam, points a jam command at it, and adds it to the user PATH. Open a new terminal, then confirm with jam --version.

```powershell
powershell -c "irm https://native.jam.dev/install.ps1 | iex"

```

```powershell
jam --version

```

--------------------------------

### Install Jam CLI skills

Source: https://jam.dev/docs/cli-record-browser

Installs the Jam CLI skills so the agent can access the recording procedure described on this page.

```bash
jam skills install

```

--------------------------------

### Verify CLI connection with jam auth status, list jams, and get jam

Source: https://jam.dev/docs/cli-reference

Run after install and auth to confirm the CLI talks to your workspace. `auth status` confirms the CLI can read the stored token, `list jams` returns a page of Jams, and `get jam` walks a single Jam by ID.

```bash
jam auth status
jam list jams --limit 5
jam get jam <id>

```

--------------------------------

### Install Jam CLI with curl

Source: https://jam.dev/docs/cli

Installs the Jam CLI on macOS and Linux. On Windows, use the PowerShell command instead.

```bash
curl -fsSL https://native.jam.dev/install | bash
```

--------------------------------

### jam skills get

Source: https://jam.dev/docs/cli-reference

Prints a bundled skill's full instructions.

```APIDOC
## jam skills get

### Description
Prints a bundled skill's full instructions.

### Command
`jam skills get <name>`

### Parameters
#### Arguments
- **name** (string) - Required - Name of the skill.

### Output
Text
```

--------------------------------

### Install Jam CLI on macOS/Linux

Source: https://jam.dev/docs/cli-reference

Installs the Jam CLI on macOS or Linux. The script detects the OS and architecture, downloads the binary to ~/.local/bin/jam, and adds it to the shell PATH. Open a new shell or source your rc file, then confirm with jam --version.

```bash
curl -fsSL https://native.jam.dev/install | bash

```

```bash
jam --version

```

--------------------------------

### jam upgrade

Source: https://jam.dev/docs/cli-reference

Installs the latest or pinned CLI binary.

```APIDOC
## jam upgrade

### Description
Installs the latest or pinned CLI binary.

### Command
`jam upgrade [--target <version>]`

### Parameters
#### Options
- **--target** (string) - Optional - Target version to install.

### Output
Side effect
```

--------------------------------

### Install ffmpeg on Windows

Source: https://jam.dev/docs/cli-reference

Installs ffmpeg on Windows via winget. Required for creating video Jams with jam create jam; ffmpeg and ffprobe read the video, extract the poster image, probe the audio track, and convert formats that are not already H.264 mp4.

```powershell
winget install ffmpeg

```

--------------------------------

### Install ffmpeg on Linux

Source: https://jam.dev/docs/cli-reference

Installs ffmpeg on Linux via apt. Required for creating video Jams with jam create jam; ffmpeg and ffprobe read the video, extract the poster image, probe the audio track, and convert formats that are not already H.264 mp4.

```bash
sudo apt install ffmpeg

```

--------------------------------

### jam skills path

Source: https://jam.dev/docs/cli-reference

Shows where skills would be installed.

```APIDOC
## jam skills path

### Description
Shows where skills would be installed.

### Command
`jam skills path [--target <agent>] [--project]`

### Parameters
#### Options
- **--target** (string) - Optional - Target agent.
- **--project** (boolean) - Optional - Show project path.

### Output
Single
```

--------------------------------

### Record a window or display with jam record run

Source: https://jam.dev/docs/cli-reference

Records a window, display, or browser page. With no selector flag and no --cdp, records the whole primary display; with --cdp and no selector, records the browser page. Use exactly one of --window-id, --app, --bundle-id, or --pid for a window, or --display for a display; do not combine them. --app and --bundle-id match case-insensitively but exactly; if multiple windows match, the command fails and lists candidates. --pid waits up to five seconds for the process to open a window. --url sets the page URL shown on the share page. Put the wrapped command after -- so its flags reach it. Command output goes to stderr; stdout carries only the Jam receipt.

```bash
jam record run -- sleep 30
jam record run --app "Google Chrome" --title "Checkout 500s" -- bun run e2e/checkout.ts
jam --json record run --window-id 4213 --title "Checkout 500s"
jam --json record run --pid $BROWSER_PID --url https://app.example.com/checkout --title "Checkout completes"
```

--------------------------------

### jam get intents

Source: https://jam.dev/docs/cli-reference

Returns the cached structured summary (what the user was trying to do, observed issues, impact). Reading it never starts an analysis. It returns `{ "status": "not_requested", "value": null }` when no summary is available.

```APIDOC
## jam get intents

### Description
Returns the cached structured summary (what the user was trying to do, observed issues, impact). Reading it never starts an analysis. It returns `{ "status": "not_requested", "value": null }` when no summary is available.

### Command
`jam get intents <id>`

### Parameters
#### Arguments
- **id** (string) - Required - Jam ID.

### Output
Single
```

--------------------------------

### List recording domains and create a recording link

Source: https://jam.dev/docs/cli-reference

Lists connected recording domains and creates a recording link. Pass a recording URL ID from the first command's output to the create command. The create command returns the link's public ID and shareable URL.

```bash
jam recording-links urls
jam recording-links create --name "Support intake" --recording-url-id <url-id> --folder "Bug reports"

```

--------------------------------

### Start OAuth2 authorization flow for Jam MCP server

Source: https://jam.dev/docs/jam-mcp

Command to start the OAuth2 authorization flow for the Jam MCP server after configuring opencode.json.

```bash
opencode mcp auth jam
```

--------------------------------

### HTML: Install Jam Recorder and Capture scripts in <head>

Source: https://jam.dev/docs/custom-recording-domain

Paste this into the <head> of every page. The meta tag sets your Team ID, and the module scripts load the Recorder and Capture scripts from the same origin.

```html
<meta name="jam:team" content="your-team-id" />
<script type="module" src="https://js.jam.dev/recorder.js"></script>
<script type="module" src="https://js.jam.dev/capture.js"></script>
```

--------------------------------

### Webhook payload example for Jam Fin workflow

Source: https://jam.dev/docs/fin-ai-setup

Example JSON payload for the Wait for Webhook step. Replace 'some string' with 'intercom.recorder.opted_out' and add 'payload' with empty curly brackets. The webhook URL is copied from this step and applies only to this specific workflow.

```json
{
  "event": "some string",
  "payload": {}
}
```

--------------------------------

### jam get events

Source: https://jam.dev/docs/cli-reference

Returns the unfiltered event stream.

```APIDOC
## jam get events

### Description
Returns the unfiltered event stream.

### Command
`jam get events <id>`

### Parameters
#### Arguments
- **id** (string) - Required - Jam ID.

#### Options
- **--limit** (integer) - Optional - Maximum number of items (default 50, max 10000).
- **--after** (integer) - Optional - Event index for pagination.

### Output
List
```

--------------------------------

### getRecordingLink

Source: https://jam.dev/docs/jam-mcp

Get one recording link by its public ID.

```APIDOC
## [GET] /recording-links/{publicId}

### Description
Get one recording link by its public ID.

### Method
GET

### Endpoint
/recording-links/{publicId}

### Parameters
#### Path Parameters
- **publicId** (string) - Required - The public ID of the recording link.

### Response
#### Success Response (200)
- **id** (string) - The public ID.
- **name** (string) - The link name.
- **revoked** (boolean) - Whether the link is revoked.

#### Response Example
{
  "id": "string",
  "name": "string",
  "revoked": false
}
```

--------------------------------

### Manual procedure for agents without skills

Source: https://jam.dev/docs/cli-record-browser

Paste this procedure into the agent if it cannot load skills. Step 4 is essential: pointing the browser tool at the cdpProxy address records user actions; skipping it yields only video and console/network data.

```text
Record what you do in the browser as a Jam, and give me the link at the end.

1. Check the CLI is signed in with `jam auth status`, and run `jam auth login` if it is not.
2. Get a DevTools address for the Chrome you drive. If your tool launched it, ask the tool
   (agent-browser: `agent-browser get cdp-url`). Otherwise launch Chrome with
   --remote-debugging-port=9222 --user-data-dir=/tmp/jam-chrome and use 9222.
3. Start the recording on that address, and keep `session` and `cdpProxy` from the receipt:
   jam record start --cdp <address> --title "<what you are showing me>" --json
4. Point your browser tool at the `cdpProxy` address instead of at Chrome, then do the work.
5. Finish with `jam record stop <session> --json` and return the `url` from the receipt.

```

--------------------------------

### Log in to Jam CLI

Source: https://jam.dev/docs/cli

Opens a browser for authentication. For CI or WSL, pipe a personal access token into `jam auth login --token` instead.

```bash
jam auth login
```

--------------------------------

### jam auth login (Browser OAuth)

Source: https://jam.dev/docs/cli-reference

Starts the browser OAuth flow. The CLI opens a browser, exchanges the authorization code for tokens, and stores them in ~/.config/jam/credentials.json.

```bash
jam auth login

```

--------------------------------

### Install ffmpeg on macOS

Source: https://jam.dev/docs/cli-reference

Installs ffmpeg on macOS via Homebrew. Required for creating video Jams with jam create jam; ffmpeg and ffprobe read the video, extract the poster image, probe the audio track, and convert formats that are not already H.264 mp4.

```bash
brew install ffmpeg

```

--------------------------------

### Record Playwright script with jam record start and CDP proxy

Source: https://jam.dev/docs/cli-record-browser

Record a Playwright script that connects to a running Chrome. Start a recording with jam record start, pass the proxy address to the script via JAM_CDP_PROXY, and stop the recording with jam record stop. The script connects over CDP and performs actions that are recorded. Puppeteer's connect({ browserURL }) takes the same address. For a Playwright run you keep after the fact, jam create jam reads the video and trace directly.

```bash
receipt=$(jam record start --cdp 9222 --json)
JAM_CDP_PROXY="$(echo "$receipt" | jq -r .cdpProxy)" node checkout.spec.js
jam record stop "$(echo "$receipt" | jq -r .session)" --json

```

```javascript
const browser = await chromium.connectOverCDP(process.env.JAM_CDP_PROXY);
const page = browser.contexts()[0].pages()[0];
await page.goto("https://example.com/checkout");
await page.getByRole("button", { name: "Pay now" }).click();

```

--------------------------------

### Paginate event reads with --limit and --after

Source: https://jam.dev/docs/cli-reference

Walks every page of an event read (e.g., `get console`) in a shell loop, printing each event with `jq -c '.events[]'` and following `nextCursor` until it is empty. Uses `--limit 1000` and passes the previous cursor via `--after` when set. The loop breaks when `nextCursor` is null or missing.

```shell
cursor=""
while :; do
  page=$(jam --json get console "$ID" --limit 1000 ${cursor:+--after "$cursor"})
  echo "$page" | jq -c '.events[]'
  cursor=$(echo "$page" | jq -r '.nextCursor // empty')
  [ -z "$cursor" ] && break
done

```
Tokens:
Raw