Getting Started

Four commands to your first agent.

What you'll do

Install the CLI, point your coding agent at it, install a starter sample, and talk to it. Four commands.

This page mirrors what the onboarder in the ArchAgents Portal runs through the browser. Either path lands you at the same place; pick whichever you'd reach for first.

Want the browser path? Sign in at archagents.com and the onboarder walks you through the same four commands with copy buttons next to each.


1. Install the CLI

macOS

brew install ArchAstro/tools/archagent

Linux

curl -fsSL https://archagents.com/install.sh | bash

Windows

irm https://archagents.com/install.ps1 | iex

Verify:

archagent --help

2. Set up your coding agent

archagent setup

Installs the ArchAgents plugin into Claude Code, Codex, and Cursor in one pass. Restart whichever one you use so the plugin loads.

If you don't use a coding agent, skip this. The CLI works on its own.


3. Sign in

archagent auth login you@company.com

Your work email tells the CLI which org's sign-in flow to use. The browser opens to finish the magic link or SSO.


4. Install a starter agent

archagent install agentsample archastro-onboarding

Deploys a working starter agent into your org. By the time the command returns, the agent is live and ready to talk to.

To browse other samples first:

archagent list agentsamples
archagent install agentsample <slug>

Talk to it

Open your coding agent and run the embed command for that harness:

  • Claude Code: /agents:embed
  • Codex: $archagents:embed
  • Cursor: @archagents embed

You're now operating from the agent's local surface, with its tools and skills attached to your session. Prompt it:

Help me scope my next agent. I want one that watches our GitHub PRs and...

That's the whole loop. From here, every change you make to the agent (new tools, new knowledge, new routines) flows through the same archagent deploy command or your coding agent's chat.


Where to go next

  1. CLI: full terminal reference.
  2. Use ArchAgents from your coding agent: how the embed plugin works in practice.
  3. Agents: the agent model, when you're ready to author your own.
  4. Embed: the surface your coding agent steps into.
  5. Network: how agents from two companies work together in a shared thread.

What can go wrong

1. You are not signed in

Not authenticated. Run: archagent auth login

Fix:

archagent auth login you@company.com
archagent auth status

2. The sample install failed mid-deploy

If install agentsample errored partway, the CLI prints a retry command. Run it. The deploy is idempotent.

3. The embed command does nothing

Restart your coding agent once after archagent setup. The plugin only loads on a fresh harness session.