Quickstart
One line starts a setup guide that checks your machine and walks you through each step, then setup asks a few questions.
One line starts the setup guide. It checks your machine and shows each step to do, with a link to the right page or the exact command. It runs nothing itself: you run every command, and it ticks the step when it's done. To start with Codex, install by hand.
Run the guide
On macOS or Linux, in Terminal:
curl -fsSL https://agentlayer.one/install.sh | bashYou can read it first. It never uses sudo. It opens with a menu: set up an agent, prepare the machine only (steps 1 to 3 below, for an agent that comes later), or check what's done. It then asks whether you'll use the agent (the plugin from the marketplace) or develop the plugin (a local clone or your fork), and goes through:
- What the agent needs: git, Node.js, Bun and Claude Code, each at the version the plugin needs. On a Mac, Homebrew comes first, since its installer brings git.
- What it recommends: on a Mac, CotEditor for editing settings files (TextEdit can turn quotes curly and break them) and MarkEdit for reading the agent's notes, each made the default app for its files; poppler to read PDFs, jq, uv, and gh for the GitHub pack.
- Your workspace, on a Mac: cmux (asked, default yes), with Ghostty first and the recommended settings for both. Without cmux, Obsidian to read the agent's notes.
- Your agent's folder,
~/Documents/Agents/<name>(default: Oppi). - The plugin, for that folder only, then its packages (about 300 MB, mostly the browser its web tools use).
A step that's already done shows a tick, so on a machine that's set up, a run is a column of ticks. While a step is open, o opens its link, c copies its command, t opens your own shell inside the guide, Enter checks again, s skips a step that isn't required, and q stops.
Start setup
The guide ends with the line that starts setup, for example:
cd ~/Documents/Agents/Oppi && claude "/agentlayer:init name=Oppi"With cmux, run it in a cmux tab: setup then offers the AgentLayer sidebar, already ticked.
Log in and trust the folder
Claude Code asks you to log in (first time only) and to trust the folder. Answer Yes: dismissing the trust question turns the plugin off.
Answer setup
Setup asks what the agent should be like, a few questions about you and your work, and how it should run, then writes the agent's files into the folder. Every question past the name can be skipped. What setup asks has the full list.
Relaunch
Setup ends by telling you to exit and start again: the plugin's registration only takes effect in a fresh session. Type /exit, then:
cd ~/Documents/Agents/Oppi && claudeIf Claude Code asks to trust a marketplace and enable a plugin, accept, or the plugin will not load. A banner with a Welcome line means it worked. From now on, always launch from this folder.
Next: your first ten minutes.
What it refuses
It stops, with the reason, when:
- it runs under
sudo, or on a system it doesn't cover AGENT_HOME, in your shell or in Claude Code's user settings, points at a folder other than your agent's (Claude Code would use that home instead)- the folder is your home folder, is inside a git repository or another agent's folder, or already holds an agent it didn't set up
- the folder is a home another plugin made: that plugin's move command copies it to a new folder for this one
A folder that already holds files needs a typed y before the guide uses it.
What it changes
Nothing. Everything installed is what you ran, from the guide's links and commands.
Flags
On macOS and Linux, flags go after bash -s --:
curl -fsSL https://agentlayer.one/install.sh | bash -s -- --name Scout| Flag | Effect |
|---|---|
--prereqs | Checks only the apps and tools, then stops: a machine made ready before any agent is set up or moved to it |
--name <name> | Sets up a new agent with this name, in ~/Documents/Agents/<name> |
--home <folder> | Sets up a new agent in this folder instead |
--marketplace | Uses the plugin from the marketplace, without asking |
--dev [<folder>] | Uses a local clone or your fork, at this folder (default ~/Developer/agentlayer-agent) |
--cmux, --no-cmux | Uses cmux as your workspace, or doesn't, without asking (macOS) |
--check | Prints what's done and what's left, then stops |
On Windows, the same flags are PowerShell parameters: -Name, -HomeFolder, -Marketplace, -Dev with -Clone <folder>, -Prereqs and -Check:
& ([scriptblock]::Create((irm https://agentlayer.one/install.ps1))) -Name ScoutIf something fails
Every open step names what's missing and how to get it. Do it and run the line again: finished steps are ticked and skipped. If a step keeps failing, install by hand. No banner after the relaunch? See the FAQ.