Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scoutica.com/llms.txt

Use this file to discover all available pages before exploring further.

Everything runs locally. Your documents and data never leave your machine — the scan command pipes your files to a local AI CLI with no cloud API calls.

​
Prerequisites

Before installing, make sure you have:
  • Git — required to publish your card to GitHub
  • Python 3 — required for card validation (python3 --version to check)
  • An AI CLI provider — at least one of the providers below must be installed for scoutica scan to work

​
Supported AI providers

scoutica scan auto-detects installed providers in this order:
ProviderCLI commandInstallUse Case
Gemini CLIgeminigoogle-gemini/gemini-cliBest for multimodal analysis (e.g., parsing PDFs directly)
Claude Codeclaudeanthropics/claude-codeBest for strict JSON adhering and rigorous schema compliance
OpenAI Codexcodexopenai/codexSolid standard API toolchain integration
Mistral Vibevibemistralai/mistral-vibeQuick, local, specialized tasks without high compute
OpenCodeopencodeopencode-ai/opencodeOpen source LLM bridging via bash
Ollamaollamaollama.com100% offline local models for absolute privacy
switchAILocalailtraylinx/switchAILocalFallback routing through your own AI proxy
OpenClawopenclawopenclaw/openclawDeep AI agent integrations and swarm coordination
You can also use --clipboard mode to copy the scan prompt to any AI chat without installing a local provider.

​
Option 1: Agent-First Install (Zero Friction)

The easiest way to generate your card is to give these instructions directly to an AI agent (like Claude Code, Cursor, or OpenClaw): 
Agent: Please install the Scoutica Protocol CLI and generate a Skill Card for my CVs in this folder.

Important constraints:
1. Ensure you are currently in the folder that contains my CV/resume files. If not, ask me which folder contains them before proceeding.
2. If the user doesn't have local AI tools (gemini, claude, ollama), run `scoutica scan . --clipboard` instead.
3. If I have PDFs, you may need `brew install poppler` for extraction.

Supported formats: .md, .txt, .pdf, .docx, .json, .yaml, .csv, .html
TTL: The preview URL generated at the end will expire in 24 hours.

Installation:
curl -fsSL https://raw.githubusercontent.com/traylinx/scoutica-protocol/main/install.sh | bash

Generation:
scoutica scan .
1

Run the installer

curl -fsSL https://raw.githubusercontent.com/traylinx/scoutica-protocol/main/install.sh | bash
The installer performs the following background tasks automatically:
  1. Scaffold config directory: Creates ~/.scoutica/ structure.
  2. Binary download: Puts the core executable in ~/.scoutica/bin.
  3. Schemas download: Pulls v1 schemas into ~/.scoutica/schemas for blazing fast offline validation.
  4. Templates download: Pulls rules and markdown templates used for generation.
  5. Path registration: Appends ~/.scoutica/bin to your PATH.
2

Reload your shell (macOS / Linux)

After installation, reload your shell configuration so the scoutica command is available:
source ~/.zshrc   # or source ~/.bashrc
3

Verify the installation

Run a diagnostic to ensure the binary is successfully in your path:
scoutica version
scoutica doctor

​
Manual Installation

For users who prefer exhaustive control over their system configuration and want to avoid piping a remote script directly to bash, you can install Scoutica Protocol manually.
1

Clone the repository

git clone https://github.com/traylinx/scoutica-protocol.git
cd scoutica-protocol
2

Create the application directory

Scoutica expects its templates and schemas to live in the SCOUTICA_HOME path (~/.scoutica/ by default).
mkdir -p ~/.scoutica/bin
mkdir -p ~/.scoutica/schemas
mkdir -p ~/.scoutica/templates/rules
3

Copy core files

Move the CLI tool and protocol assets into your home directory:
cp tools/scoutica ~/.scoutica/bin/scoutica
chmod +x ~/.scoutica/bin/scoutica

cp schemas/*.json ~/.scoutica/schemas/
cp protocol/templates/*.txt ~/.scoutica/templates/
cp protocol/templates/rules/*.md ~/.scoutica/templates/rules/
4

Update your PATH

Add the binary to your shell’s binary path. E.g. for ZSH:
echo 'export PATH="$HOME/.scoutica/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

​
Keeping the CLI up to date

Updates are natively handled by the CLI through the update daemon. Unlike Node.js or Homebrew packages, it manages itself cleanly inside of ~/.scoutica. 
scoutica update
This will compare your local VERSION against the remote GitHub stable branch. If an update exists, it streams the latest core assets instantly. No node modules, no dependencies.

​
Troubleshooting

scoutica: command not found Ensure that ~/.scoutica/bin actively exists in your $PATH. Check it by running: 
echo $PATH | grep scoutica
PDF text extraction fails during scan If you feed PDF CVs into scoutica scan ~/CV, it requires pdftotext. 
brew install poppler
Empty response from provider Ensure your local AI provider is configured and authenticated. 
gemini --version

​
What’s next

Now that the CLI is installed seamlessly, let’s create your first profile:

Quick start

Walk through the complete flow: scan, validate, and publish your Skill Card in 5 minutes.