The CLI¶
The falco CLI is included with the package installation. It provides a set of commands that I hope will be useful to you throughout the lifecycle of your project, from project setup to deployment.
Note
If you encounter any issues or unexpected behavior with the CLI, please report it on GitHub.
The entrypoint for the CLI is the falco
command. It is used to execute all other subcommands.
Most of these commands rely on the presence of the manage.py
file, so ensure that you run them from the root directory of your Django project.
Additionally, these commands require acces to your virtual environment, so make sure to activate it before executing any command.
Important
There is a known issue where certain commands, which depend on your Django project environment to work, such as the work
or the
crud
commands, might occasionally fail to run. The exact cause of this issue is not entirely clear at the moment, and I’ve
experienced it a few times myself. The simplest solution for now is to install the falco-cli
in the same virtual environment as your project.
This should resolve the issue.
Usage: falco {start-project,start-app,crud,install-crud-utils,htmx,htmx-ext,work,sync-dotenv,rm-migrations,reset-migrations} [-h] [--completion COMPLETION]
Enhance your Django developer experience: CLI and Guides for the Modern Django Developer.
Subcommands
start-project Initialize a new django project the falco way.
start-app Initialize a new django app the falco way.
crud Generate CRUD (Create, Read, Update, Delete) views for a model.
install-crud-utils Install utils necessary for CRUD views.
htmx Download the latest version (if no version is specified) of htmx.
htmx-ext Download one of htmx extensions.
work Run your whole django projects in one command.
sync-dotenv Synchronize the .env file with the .env.template file.
rm-migrations Remove all migrations for the specified applications directory, intended only for development.
reset-migrations Delete and recreate all migrations.
Help
[-h, --help] Show this message and exit.
[--completion COMPLETION] Use `--completion generate` to print shell-specific completion source. Valid options: generate, complete.