Installation

Install FlyDocs in your project with a single command. No accounts, no API keys, no configuration required.

FlyDocs installs in under a minute. No accounts, no API keys, no configuration required.

Prerequisites

  • Node.js 18.17 or later
  • Python 3.8 or later (for skill scripts)
  • A git repository (FlyDocs works best in version-controlled projects)
  • An AI coding tool: Claude Code, Cursor, or Windsurf

Install the CLI

Terminal
npm install -g @flydocs/cli@beta

Run FlyDocs in your project

Terminal
cd your-project
flydocs

What happens:

  • Detects your stack (frameworks, testing tools, languages)
  • Recommends skills based on what's in your code
  • Generates structured context files
  • Installs hooks, commands, and agent definitions
  • Creates a .flydocs/ configuration directory

Set up your project

Open your project in your AI coding tool and run /flydocs-setup. The AI will:

  • Review and refine the generated project context
  • Walk through conventions and patterns for your codebase
  • Set up any additional context from existing documentation

This step is where FlyDocs onboards you. By the time it's done, you understand the tool and your project is configured.

Verify the installation

Terminal
flydocs --version

Your project should now have:

  • flydocs/: project context, issues, and knowledge base
  • .flydocs/: configuration, hooks, and scripts
  • .claude/: Claude Code skills, commands, and settings
  • .cursor/: Cursor rules and settings

Updating

Terminal
flydocs update --here

Updates owned files (skills, hooks, scripts, commands) while preserving your project context, configuration, and custom settings.

Need help?

  • Join the Discord. It's where we hang out, share updates, and talk through ideas. Best place to report bugs, suggest features, or connect with other people using FlyDocs.
  • Check Command Reference for available slash commands
  • Read How It Works to understand the full system