Install Archcore
Install Archcore, then initialize it in your project and connect the agent you use. Complete any host-specific steps printed by the installer before starting the quick start.
Prefer to install from your AI agent?
You can also add Archcore through Claude Code, Codex CLI, Cursor, or GitHub Copilot CLI. Follow the installation instructions for your agent to add the Archcore plugin.
This is another entry point to the same Archcore setup. 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
Section titled “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.
curl -fsSL https://archcore.ai/install.sh | bashirm https://archcore.ai/install.ps1 | iexOpen a new PowerShell window after installation so it picks up the updated PATH.
Check that the executable is available:
archcore --versionThe command prints the installed version. If it is not found, follow PATH troubleshooting.
2. Connect your project
Section titled “2. Connect your project”In your project’s root directory, run:
archcore initArchcore creates .archcore/ and configures supported agents. If it asks you to select agents, select the ones you use. Selecting a host also authorizes installation of the Archcore plugin where that host supports it.
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-codeReplace 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, plugin installation commands are printed rather than executed. --yes without --agent also leaves that step for you.
3. Check the connection
Section titled “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
Section titled “Update Archcore”archcore updateThis 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
Section titled “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
Section titled “Next steps”Follow the quick start to record a real project decision and retrieve it in another session.