swarmvault quickstart / scan

swarmvault quickstart is the beginner-friendly one-command path. It uses the same implementation as swarmvault scan, which remains the concise command for existing users and automation.

Default swarmvault --help now keeps quickstart visible and hides the older aliases. scan and clone still work, and direct help such as swarmvault scan --help remains available.

Usage

swarmvault quickstart <file-or-directory-or-github-url>
swarmvault quickstart <file-or-directory-or-github-url> --no-serve
swarmvault quickstart <file-or-directory-or-github-url> --mcp
swarmvault scan <file-or-directory-or-github-url>
swarmvault scan <file-or-directory-or-github-url> --no-serve
swarmvault scan <file-or-directory-or-github-url> --no-viz
swarmvault scan <file-or-directory-or-github-url> --mcp
swarmvault clone https://github.com/owner/repo --branch main --no-viz
swarmvault quickstart ./manual.pdf --no-serve
swarmvault scan <directory> --port 4310
swarmvault scan https://github.com/owner/repo --branch main --no-serve

Options

  • --port <port> - Port for the graph viewer
  • --no-serve - Skip launching the graph viewer after compile
  • --no-viz - Compatibility alias for --no-serve
  • --mcp - Start the MCP stdio server after compile instead of the viewer
  • --branch <name> - Clone a public GitHub repo source from a specific branch
  • --ref <ref> - Check out a tag, commit, or ref after cloning a public GitHub repo source
  • --checkout-dir <path> - Reuse a persistent checkout directory for a public GitHub repo source
  • --install-agent-rules - Install configured agents targets during initialization

What It Does

quickstart and scan run the fast first-pass flow in the current directory:

  1. Initializes the current directory as a SwarmVault workspace
  2. Ingests the supplied local file or directory, or registers and syncs the supplied public GitHub repo root URL
  3. Compiles the resulting manifests into wiki, graph, and search artifacts
  4. Writes wiki/graph/share-card.md, wiki/graph/share-card.svg, and wiki/graph/share-kit/ for quick sharing
  5. Prints swarmvault next as the final orientation step in human output
  6. Starts graph serve unless you pass --no-serve or --no-viz; --mcp starts the MCP stdio server instead

Use quickstart in onboarding and docs. Use scan when you prefer the older concise command name. Run swarmvault next afterward when you want a read-only status check and recommended follow-up commands.

Interactive file and directory runs show bounded progress on stderr, including the active file and processed content size. JSON, MCP, watch, and CI-style flows stay quiet. Agent rule files are not installed by default; run swarmvault install --agent <agent> or pass --install-agent-rules with configured agents when you want them.

swarmvault clone is a top-level compatibility alias for the same flow and accepts the same checkout, viewer, and MCP flags.

After a scan, run swarmvault graph share --post to print copyable text, swarmvault graph share --svg ./share-card.svg to write the visual card, or swarmvault graph share --bundle ./share-kit to write a portable folder with markdown, post text, SVG, HTML preview, and JSON metadata.

If you want the directory to stay registered and reloadable over time, use source add <directory> instead. Public GitHub repo scans are registered as managed sources automatically.