Skip to content

docs: update getting-started setup description #364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
codeaholicguy merged 1 commit into from
Oct 10, 2026
Merged

docs: update getting-started setup description #364

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions web/content/docs/1-getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ order: 1

Getting started has two scopes:

1. **Once per machine:** run `setup` to connect detected local agents, install their session integrations, and install AI DevKit's built-in skills globally.
1. **Once per machine:** run `setup` to connect detected local agents, install their session integrations and built-in skills globally, and wire the AI DevKit memory MCP server into MCP-capable agents.
2. **Once per project:** run `init` to create `.ai-devkit.json`, environment-specific project files, and workflow documentation.

Keeping these steps separate makes it clear which changes affect your machine and which files belong in your project.
Expand Down Expand Up @@ -69,7 +69,15 @@ An npx-only installation does not make a permanent `ai-devkit` command available

### Machine setup

`setup` checks for supported agent home directories. For each detected agent, it installs the available session hook or tracker and the AI DevKit built-in skills in that agent's global skill location.
`setup` checks for supported agent home directories. For each detected agent, it installs the available session hook or tracker, installs the AI DevKit built-in skills in that agent's global skill location, and wires the `ai-devkit-memory` MCP server into agents with a user-level MCP config (see [Memory](/docs/6-memory)).

To set up only specific agents, pass a comma-separated list:

```bash
ai-devkit setup --agent claude,codex
```

Supported values: `codex`, `pi`, `claude`, `gemini`, `cursor`, `opencode`, `grok`.

Read the setup summary carefully. A skipped agent was not changed. If an agent you use is skipped, launch it once and rerun the same setup command.

Expand All @@ -91,7 +99,13 @@ If the directory is not already a Git repository and Git is available, `init` al

## Verify the First Run

Restart your coding agent after machine setup, then start an agent session in the initialized project. Check discovery before opening the console:
Restart your coding agent after machine setup, then start an agent session in the initialized project. First check overall readiness:

```bash
ai-devkit status
```

`status` reports the CLI version, project config, per-agent readiness (executable, auth, skills), tmux, skill registries, channels, and memory MCP wiring. Then check discovery before opening the console:

```bash
ai-devkit agent list
Expand Down
Loading