# Install Archcore

> Install Archcore on your platform, connect your coding agent, and check that project tools are available.

The install script adds the CLI and the Archcore plugin for Claude Code, Codex CLI, GitHub Copilot CLI, and OpenCode 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**, **GitHub Copilot CLI**, or **OpenCode**. Follow the [installation instructions for your agent](/guides/connect-your-agent/#install-per-host).

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”](#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

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

* Windows

  ```powershell
  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:

```bash
archcore --version
```

The command prints the installed version. If it is not found, follow [PATH troubleshooting](/guides/troubleshooting/#archcore-not-in-path).

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. The OpenCode plugin goes into the global OpenCode config and needs no project. If you pin `ARCHCORE_VERSION` to v0.14.3 or older, the installer skips OpenCode with a notice; run `archcore init --agent opencode` in a project instead.

## 2. Connect your project

[Section titled “2. Connect your project”](#2-connect-your-project)

In your project’s root directory, run:

```bash
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:

```bash
archcore init --agent claude-code
```

Replace `claude-code` with your [agent ID](/guides/connect-your-agent/#supported-hosts). 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                                             |
| OpenCode           | Restart OpenCode. The installer or `archcore init --agent opencode` adds the plugin to the global OpenCode config |
| Other agents       | Follow the [connection instructions](/guides/connect-your-agent/) for the available capabilities                  |

[Host setup details](/guides/connect-your-agent/#supported-hosts) 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

[Section titled “3. Check the connection”](#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](/guides/troubleshooting/).

Terminal setup prepares the directory and connection. The [quick start](/start/quick-start/) adds your first project knowledge.

## Update Archcore

[Section titled “Update Archcore”](#update-archcore)

```bash
archcore update
```

This updates the executable and refreshes the plugin on hosts that already carry it. The [command reference](/cli/commands/#archcore-update) describes background updates and the check-only option.

## Other installation details

[Section titled “Other installation details”](#other-installation-details)

For pinned versions, custom directories, and offline use, see [installation settings](/cli/configuration/#installation-settings). The installer and update path send anonymous installation events; [privacy and opt-out](/cli/configuration/#analytics-and-opt-out) describes their scope.

## Next steps

[Section titled “Next steps”](#next-steps)

[Follow the quick start](/start/quick-start/) to record a real project decision and retrieve it in another session.