Docs

/ flydocs scan

AI-generate project context files from your codebase.

Synopsis

terminal 
flydocs scan [flags]

Triggers a server-side AI analysis of your repository to generate project context files. The scan produces a project.md with your project's scope, stack, and conventions, and a service.json describing the service topology. Both files are written to flydocs/context/.

Options

Flag Type Default Description
--repo string -- Full repository name (owner/repo). Auto-detects from the git remote if omitted.
--force boolean false Overwrite existing context files. Without this flag, existing files are preserved.

What It Does

  1. Detects the repository from the git remote origin, or uses the --repo flag
  2. Sends the scan request to the FlyDocs relay API for server-side AI analysis
  3. Generates project.md containing the project's description, tech stack, coding standards, and architectural decisions
  4. Generates service.json describing the service topology, dependencies, and cross-repo relationships
  5. Writes output to flydocs/context/ in your project directory

The generated context is what FlyDocs uses to give AI coding tools awareness of your project. You can edit these files after generation -- they are yours to maintain. On cloud tier, the portal is the source of truth and local copies are refreshed on sync.

Examples

Scan the current repository:

terminal 
flydocs scan

Scan with an explicit repository name:

terminal 
flydocs scan --repo myorg/my-project

Force-overwrite existing context files:

terminal 
flydocs scan --force

Related Commands

  • flydocs init: Use --scan to run a scan as part of initialization
  • flydocs sync: Pull context updates from the cloud portal