Docs

/ flydocs connect

Connect an existing FlyDocs project to the cloud portal.

Synopsis

terminal 
flydocs connect [flags]

Upgrades a local-tier FlyDocs project to cloud by adding authentication and connecting to your workspace. Requires an existing .flydocs/config.json in the project — run flydocs init --tier local first if you don't have one.

Options

Flag Type Default Description
--path string cwd Project directory containing .flydocs/config.json.
--here boolean false Use the current directory.
--local-source boolean false Use local templates instead of server templates. For development only.
--key string -- API key (fdk_...). Skips the interactive prompt.

What It Does

  1. Validates that .flydocs/config.json exists in the target directory
  2. Prompts for API key (or uses --key) and validates it against the relay API
  3. Stores the API key globally at ~/.flydocs/credentials for the FlyDocs CLI to use across projects
  4. Updates tier from local to cloud in the project config and links it to your cloud workspace
  5. Suggests flydocs update next to refresh server-managed skill scripts for the workspace

Use this when you started with flydocs init --tier local and are ready to connect to the cloud for issue tracking, project management, and team sync.

Examples

Connect the current directory interactively:

terminal 
flydocs connect --here

Connect with an API key directly:

terminal 
flydocs connect --here --key fdk_abc123

Connect a project in a different directory:

terminal 
flydocs connect --path ./my-project

Related Commands

  • flydocs init: Full initialization (installs and connects in one step)
  • flydocs auth: Store an API key globally without modifying a project
  • flydocs upgrade: Learn about cloud tier benefits before connecting