Skip to content

CLI Binaries

Flyokai deploys three CLI entry points to bin/. Each loads a different application type and command loader.

Binaries

Binary App Type When to Use
vendor/bin/flyok-setup setup First-time installation only (install command). Bootstraps the project and deploys bin/ scripts.
bin/flyok-setup setup Subsequent install / upgrade commands after initial installation.
bin/flyok-console cli General-purpose commands: acl:role:create, user:create, oauth:client:create, etc.
bin/flyok-cluster cluster Running the application cluster (start, stop, restart).

Key Rules

  • Never use vendor/bin/flyok-setup after the initial install — use bin/flyok-setup instead.
  • Never use bin/flyok-setup for general commands — use bin/flyok-console.
  • All bin/ scripts require php prefix if not marked executable (e.g., php bin/flyok-console).

Examples

# First-time install
vendor/bin/flyok-setup install --db-user=... --db-pass=... --db-name=... --base-url=...

# Subsequent upgrade
php bin/flyok-setup upgrade

# Create ACL role, user, OAuth client
php bin/flyok-console acl:role:create --name admin '[]'
php bin/flyok-console user:create --uname=admin --email=admin@example.com --role=admin --pass=secret123
php bin/flyok-console oauth:client:create admin client_credentials

# Start cluster
php bin/flyok-cluster start