Skip to Content
CLIGlobal Options

Global Options and Auth

Global options are available for all Flexkit CLI commands.

Global Options

OptionDescription
-h, --helpOutput usage information.
-v, --versionOutput the CLI version.
--cwd <DIR>Set the working directory for this command invocation.
-A, --local-config <FILE>Path to a local flexkit.config.ts project config file.
-Q, --global-config <DIR>Path to the global configuration directory.
-d, --debugEnable debug output.
--no-colorDisable colored output.
-S, --scope <SCOPE>Set a custom scope (used by commands that support scoped operations, such as project).
-t, --token <TOKEN>Use a token for this run instead of persisted credentials.

Authentication Behavior

  • Commands that require auth prompt for login in TTY mode if no credentials exist.
  • In non-interactive environments, use --token.
  • Token format must be flk- followed by 32 hexadecimal characters.
  • login, logout, whoami, and help can run without an existing token.

Common Examples

# Show CLI version
flexkit --version
 
# Use a specific project config file
flexkit --local-config ./config/flexkit.config.ts deploy
 
# Run with one-off token in CI
flexkit --token "$FLEXKIT_TOKEN" project ls --json
Last updated on

© 2026