Commands

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.

Command	Description
`help`	Help about any command
`about`	Prints information about the application
`optimize`	Flush all caches and optimize the application
`routes`	List all registered API routes
`seed`	Seed the database with initial data
`server`	Start the Fluxend API server
`udb.stats`	Pull stats from given database
`udb.restart`	Restart all PostGREST instances

Make Commands

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

Use make help for list all available commands

Command	Description
`make help`	Shows help information
`make setup`	Setup the project
`make build`	Build the project
`make up`	Start the project
`make down`	Stop the project
`make login.app`	Login to fluxend container
`make login.db`	Login to database container
`make pgr.list`	List all postgrest containers
`make pgr.destroy`	Destroy all postgrest containers
`make docs.generate`	Generate docs
`make lint`	Run linter
`make lint.fix`	Run linter and fix
`make server`	Run the project in development mode
`make seed`	Seed the database
`make about`	Show the project information
`make optimize`	Optimize the project
`make udb.stats`	Show the database stats
`make udb.restart`	Restart all PostGREST instances
`make routes.list`	Show all the available routes
`make drop.user.dbs`	Drop all user-created databases
`make migration.create`	Create a new database migration
`make migration.up`	Run database migrations
`make migration.down`	Rollback database migrations
`make migration.status`	Show the status of the database migrations
`make migration.reset`	Rollback all migrations and run them again
`make migration.redo`	Rollback the last migration and run it again
`make migration.fresh`	Rollback all migrations and run them again
`make seed.fresh`	Seed 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

Get Started

Essentials

API Reference

Introduction

CLI Commands

Make Commands

Common Usage Examples

​ Introduction

​ CLI Commands

​ Make Commands

​Common Usage Examples

Introduction

CLI Commands

Make Commands

Common Usage Examples