​
Introduction

Fluxend provides two sets of commands to help you manage your application: CLI commands for direct application interaction and Make commands for development workflow automation.

​
CLI Commands

The Fluxend CLI allows you to start the server, run seeders, and inspect routes.

Use fluxend [command] --help for more information about a specific command.

CommandDescription
helpHelp about any command
aboutPrints information about the application
optimizeFlush all caches and optimize the application
routesList all registered API routes
seedSeed the database with initial data
serverStart the Fluxend API server
udb.statsPull stats from given database
udb.restartRestart all PostGREST instances

​
Make Commands

Make commands provide convenient shortcuts for development tasks and project management.

Use make help for list all available commands

CommandDescription
make helpShows help information
make setupSetup the project
make buildBuild the project
make upStart the project
make downStop the project
make login.appLogin to fluxend container
make login.dbLogin to database container
make pgr.listList all postgrest containers
make pgr.destroyDestroy all postgrest containers
make docs.generateGenerate docs
make lintRun linter
make lint.fixRun linter and fix
make serverRun the project in development mode
make seedSeed the database
make aboutShow the project information
make optimizeOptimize the project
make udb.statsShow the database stats
make udb.restartRestart all PostGREST instances
make routes.listShow all the available routes
make drop.user.dbsDrop all user-created databases
make migration.createCreate a new database migration
make migration.upRun database migrations
make migration.downRollback database migrations
make migration.statusShow the status of the database migrations
make migration.resetRollback all migrations and run them again
make migration.redoRollback the last migration and run it again
make migration.freshRollback all migrations and run them again
make seed.freshSeed the database with fresh data

Commands like drop.user.dbs and migration.reset commands can result in data loss. Use with caution in production environments.

​
Common Usage Examples

Start development:

make setup
make up
make server

Database operations:

make migration.up
make seed

Container access:

make login.app    # Access application container
make login.db     # Access database container