Skip to content

Setting It Up

Two commands to install, one to sign in. The guidance is bundled with the CLI, so there is nothing to download separately and nothing to keep in sync by hand.

Install

sh
npm install -g @cloudbeat/atlas-cli @cloudbeat/atlas-recorder
atlas login --token <your API token>
atlas skills install

Create the token on your Profile page in Atlas. A token acts as you, in one account, so the agent can never reach further than you can.

Requires CLI 0.4.0 or newer

atlas skills install arrived in 0.4.0. Check with atlas --version, and upgrade with npm install -g @cloudbeat/atlas-cli@latest.

The recorder is a separate package because it downloads its own browser. Install it when you want an agent to record scenarios; skip it in CI, where nothing opens a browser.

What gets installed

atlas skills install writes into the current project:

.claude/skills/
  atlas-load-test/SKILL.md     the end-to-end flow
  atlas-record/SKILL.md        recording a scenario from a browser
  atlas-test-plan/SKILL.md     plans, data files, local debugging
  atlas-correlate/SKILL.md     per-session values: tokens, session ids
  atlas-run/SKILL.md           sizing, thresholds, CI
  atlas-analyze/SKILL.md       reading results, and spotting a broken test
AGENTS.md                      the same guidance, vendor-neutral

See The Skills for what each one covers and when it loads.

Start a new assistant session afterwards. Skills and AGENTS.md are read when a session starts, so an open session will not see them.

Where to install it

CommandInstalls intoUse when
atlas skills installthe current projectThe repository whose performance you are testing — the usual choice, and it can be committed so your team shares it
atlas skills install --useryour home directoryYou want every project on your machine to have it
atlas skills install --dir <path>anywhereUnusual layouts, or a shared checkout

Existing files are left alone, because you may have edited them for your project. Pass --force to replace them:

sh
atlas skills install --force

To see what a build carries before installing anything:

sh
atlas skills list

Claude Code

Nothing else to do. Open Claude Code in the project and ask for a load test — the relevant skill loads by itself when the request calls for it. You can confirm they are there with /skills.

Committing .claude/skills/ to your repository means everyone on the team gets the same behaviour, and reviews changes to it like any other file.

Copilot, Cursor, Codex and friends

These read AGENTS.md from the project root, which atlas skills install writes for you. No configuration, no extension. Commit it alongside your code.

If your assistant reads a differently named file, copy it:

sh
cp AGENTS.md CLAUDE.md          # or .cursorrules, .github/copilot-instructions.md

Keeping it current

The guidance ships inside the CLI, so upgrading the CLI brings new guidance with it:

sh
npm install -g @cloudbeat/atlas-cli@latest
atlas skills install --force

Worth doing when you upgrade, because the guidance tracks the commands. If you have edited a skill for your own project, diff before overwriting.

Check it works

Ask your assistant something that needs Atlas but changes nothing:

What can I load test here, and how much capacity do I have?

You should see it run atlas projects and atlas capacity, then answer with your real projects and machine count. If it improvises shell commands or asks you for infrastructure credentials, the guidance has not loaded — start a new session and check .claude/skills/ or AGENTS.md is present.

What it can do →

Atlas — load testing by CloudBeat