Skip to content

Quick Start

Native Agent Install (Most Recommended)

The quickest way to install and configure everything is to give your AI agent (like Claude Code, Cursor, OpenCode, or OpenClaw) a single instruction. The agent will read the protocol and execute the entire setup autonomously in the background.

The simulation below uses the full POSIX implementation. On Windows, the agent must stay within the windows-subset-v1 commands documented in the manual-install step.

Copy this prompt and paste it into your AI Agent:

Read https://raw.githubusercontent.com/traylinx/scoutica-protocol/main/SKILL.md and follow the instructions to set up Scoutica Protocol natively.

1. Step 1: Install CLI

  • AI executes bash: curl -fsSL https://raw.githubusercontent.com/traylinx/scoutica-protocol/main/install.sh | bash
  • Terminal Output: βœ… Scoutica installed successfully.

2. Step 2: Locate files & Scan

  • AI executes bash: cd ~/CV && scoutica scan .
  • Terminal Output: Creating dedicated card folder: ~/CV/john-doe-card

3. Step 3: Schema Validation

  • AI executes bash: scoutica validate
  • Terminal Output: βœ… All files passed.

4. Step 4: Network Registration & Publishing

  • AI executes bash: scoutica register . --type candidate and scoutica publish
  • Terminal Output: βœ… Successfully published to GitHub! Registered on the Scoutica Network.

Manual CLI Install

If you prefer to install it yourself, run the installer:

Terminal window
curl -fsSL https://raw.githubusercontent.com/traylinx/scoutica-protocol/main/install.sh | bash
source ~/.zshrc # or source ~/.bashrc

Then, build your card manually using one of these methods:

Let AI generate your card automatically from your local documents.

Terminal window
scoutica scan ~/my-docs/

Use a specific AI provider explicitly:

Terminal window
scoutica scan ~/my-docs/ --with gemini # Gemini CLI
scoutica scan ~/my-docs/ --with claude # Claude Code
scoutica scan ~/my-docs/ --with ollama # Ollama (offline privacy)

After creation, your card folder looks like this:

my-card/
β”œβ”€β”€ profile.json # Your skills, experience, tools
β”œβ”€β”€ rules.yaml # Your rules of engagement
β”œβ”€β”€ evidence.json # Links to your public work
└── SKILL.md # Agent entry point

Validate your card

Run the schema validator to check your card for errors:

Terminal window
scoutica validate ./my-card/

Expected output:

βœ… 5 checks passed

Fix any validation errors before publishing.

Publish to GitHub

Push your card to your GitHub repository:

Terminal window
scoutica validate && scoutica publish

Your card is now live and discoverable by any AI agent at your GitHub repo URL.