getting-started.md

🚀 Getting Started with ARCA

⬇️ Installation

🪟 Windows (Winget)

winget install ARCA.CLI

🪟 Windows (Manual)

Download the latest arca.exe from the GitHub Releases and add it to your PATH.

🍎 macOS/Linux (Homebrew)

brew install arca-cli/tap/arca

🛠️ From Source

go install github.com/adryledo/arca-cli/cmd/arca@latest

📖 Basic Usage

1. 🏗️ Initialize a project

Use the install command to create the .arca-assets.yaml file in your project root

2. 📦 Install an asset

# Add an asset from a GitHub repository
arca install https://github.com/org/assets my-asset --target .github/instructions/my-asset.md

3. 🔄 Sync existing assets

If you've cloned a project that already has an ARCA configuration:

# Downloads missed assets and restores symlinks
arca sync

4. 🔀 Direct tool projections

Map an asset to specific AI assistants:

# Map to both Copilot and Cursor locations
arca install https://github.com/org/assets my-asset --name cursor --target .cursor/rules/my-asset.md

5. 🔍 Listing and Browsing

# List assets in a remote manifest
arca list-remote https://github.com/org/assets

# List currently installed assets in the project
arca list

# Output in JSON for tool integration
arca list --json

6. 🧑‍💻 Maintainer Workflow

# Add a new version of an asset to the local arca-manifest.yaml
arca publish my-asset 1.2.0 instruction instructions/my-asset.md

---

Previous: Purpose & Benefits | Documentation Index | Next: Protocol Deep-Dive