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.

The scan command is the powerhouse of the Scoutica Protocol. It takes any directory of unstructured text, PDFs, or code and compresses it into a high-fidelity, machine-readable professional profile.
scan is incredibly powerful but demands a properly configured local AI provider in your PATH (e.g. gemini, claude, or ollama).

​
Command Syntax

scoutica scan [options] <source-directory> [output-directory]

​
Options

OptionBehavior
--clipboardSkips executing the local AI CLI call. Instead, it aggressively copies the deeply formatted prompt and embedded documents directly into your system clipboard, allowing you to paste it into ChatGPT, Claude.ai, or Gemini Advanced.
<source>Required. The directory containing your unstructured data (PDFs, Markdown, text, code, CVs).
[output]Optional. The directory to write the generated JSON/YAML to. Defaults to ./.

​
The AI Parsing Pipeline

What it does: When you run scoutica scan ~/CV, the CLI engine initiates the following operations:
  1. Recurses through the source directory (respecting .gitignore boundaries if present).
  2. Uses pdftotext to flatten any rich PDFs into rigorous raw plaintext.
  3. Ingests all Markdown (.md), Code, and Text files.
  4. Wraps this context tightly inside a massive system prompt (pulled from your ~/.scoutica/templates/scoutica_prompt.txt).
  5. Hands the payload to your installed LLM CLI.
  6. The AI enforces strict Schema Output mapping to the Scoutica Protocol.
  7. The JSON response is caught, parsed, and decoupled into profile.json, rules.yaml, evidence.json, and SKILL.md.
Why use it:
  • Zero-effort adoption: Mapping 10 years of professional experience across 5 different companies into a JSON schema manually takes hours. scoutica scan accomplishes it in 15 seconds.
  • Continuous Maintenance: You can run scan against a folder containing 3 new certifications, and it will automatically update your profile.

​
Use Case A: Zero-to-One

You have a folder called ~/professional/ containing resume.pdf, cover-letter.txt, and aws-cert.pdf. 
scoutica scan ~/professional/ ./my-new-card/
The AI reads your Amazon certificate, places it under evidence.json, reads your PDF resume, structures it into profile.json, infers your location and remote preference into rules.yaml. You are completely done and ready to validate and publish.

​
Use Case B: The Clipboard Hack

You do not want to install any CLI dependencies, but you DO have an enterprise subscription to ChatGPT. You have a folder of complicated legal documents you wrote proving your legal history. 
scoutica scan ~/legal-history/ --clipboard
Your clipboard now contains the master protocol system prompt + all the parsed text. You simply hit CMD+v inside ChatGPT, and it spits back exactly the structured files you need to copy into your repository.