Install Archcore

The install script adds the CLI and the Archcore plugin for Claude Code, Codex CLI, and GitHub Copilot CLI when those host commands are already on PATH. Run archcore init later in each project where you want MCP tools and hooks.

Prefer to install from your AI agent?

You can also add the plugin through Claude Code, Codex CLI, Cursor, or GitHub Copilot CLI. Follow the installation instructions for your agent.

The plugin needs the Archcore executable on PATH; it does not download it. If the executable is missing, complete step 1 below. Then connect your project and check the connection in steps 2 and 3.

1. Install on your machine

On macOS and Linux, you need bash, curl, tar, and sha256sum or shasum. On Windows, use PowerShell 5.1 or later. In WSL, use the Linux command inside WSL.

macOS / Linux

curl -fsSL https://archcore.ai/install.sh | bash

Windows

irm https://archcore.ai/install.ps1 | iex

Open a new PowerShell window after installation so it picks up the updated PATH.

Check that the executable is available:

archcore --version

The command prints the installed version. If it is not found, follow PATH troubleshooting.

The installer uses the host’s own plugin command for each supported host CLI it finds. It reports a retry command if a host install fails. If you install a host after Archcore, run archcore plugin install --agent <id>. Plugin setup is skipped in CI and when ARCHCORE_SKIP_PLUGIN_INSTALL is set to a nonzero value. Cursor still needs installation through its Plugins panel.

2. Connect your project

In your project’s root directory, run:

archcore init

Archcore creates .archcore/ and configures supported agents. If it asks you to select agents, select the ones you use. It also installs a plugin that is still missing for a selected host.

If Archcore detects an existing agent configuration, it can configure that agent without installing the plugin. Follow the printed installation hint, or name the host explicitly:

archcore init --agent claude-code

Replace claude-code with your agent ID. On an interactive run, accept the instruction-hint prompt to tell the agent when to consult Archcore. A named --agent writes that hint without another prompt.

Agent	Complete this before continuing
Claude Code	Restart the session after setup
Cursor	Add the plugin in Cursor’s UI; confirm MCP points at your project
Codex CLI	Restart the session; enable its hooks feature for automatic context and write guards
GitHub Copilot CLI	Run setup in the project so its MCP entry exists; restart the session
Other agents	Follow the connection instructions for the available capabilities

Host setup details cover the additional steps. In CI, init prints plugin installation commands rather than executing them. --yes without --agent also leaves that step for you.

3. Check the connection

Open a new agent session in the same project and ask:

Use Archcore to list this project’s documents. If the list is empty, report that without creating anything.

The agent should call list_documents. An empty list is a valid result for a new project. A missing tool or connection error means setup is incomplete; see Troubleshooting.

Terminal setup prepares the directory and connection. The quick start adds your first project knowledge.

Update Archcore

archcore update

This updates the executable and refreshes the plugin on hosts that already carry it. The command reference describes background updates and the check-only option.

Other installation details

For pinned versions, custom directories, and offline use, see installation settings. The installer and update path send anonymous installation events; privacy and opt-out describes their scope.

Next steps

Follow the quick start to record a real project decision and retrieve it in another session.