WELCOME TO YOUR APPLICATION

Let’s get started.

Your __AMEN_APP_NAME__ project is ready. AMEN takes care of the setup, so you can focus on building with __AMEN_FRAMEWORK_NAME__.

__AMEN_FRAMEWORK_NAME____AMEN_DATABASE_NAME__Built with AMEN v__AMEN_VERSION__
Explore AMEN commands
Service not checkedCheck the application’s live health endpoint
GET/healthAwaiting check
Run a check to inspect the response.

AMEN commands

Run project commands from the directory containing __AMEN_APP_NAME__/.
The am alias works too.

16 command examples

Run your application

Start the development server using your project’s Python environment.

amen run __AMEN_APP_NAME__

Create a project

Launch the setup wizard to choose a framework, application type, and database.

amen create

Add an endpoint

Create an API endpoint module and register its route with your application.

amen add __AMEN_APP_NAME__ endpoint hello

Create a page

Generate a template and its view route, ready for your own HTML.

amen add __AMEN_APP_NAME__ view about

Add a utility

Create a reusable utility module without replacing existing project files.

amen add __AMEN_APP_NAME__ util helpers

Run your tests

Run pytest with coverage using the project’s virtual environment.

amen test __AMEN_APP_NAME__

Install a package

Install a Python package into this project’s virtual environment.

amen install __AMEN_APP_NAME__ requests

Migrate your database

Generate and apply migrations with Flask-Migrate or Alembic. Requires a database-enabled project.

amen migrate __AMEN_APP_NAME__

Check your code

Scan Python source with Bandit for potential security issues.

amen audit __AMEN_APP_NAME__

Monitor your app

Inspect process status and resource usage. Set --port to match your running server.

amen monitor __AMEN_APP_NAME__ --port __AMEN_DEFAULT_PORT__

Edit configuration

Open the project’s .env file in the Ring desktop editor.

amen config __AMEN_APP_NAME__

Open the project creator

Launch AMEN’s browser-based project setup interface on port 5050.

amen web

Browse offline docs

Serve the bundled AMEN documentation on port 5051, separate from your app.

amen docs --port 5051

About AMEN

Show the installed AMEN version, author, and project information.

amen about

Update the CLI

Check for a newer AMEN release and follow the update prompt.

amen update

See every option

List available commands. Add --help after any command to see its options.

amen --help
Make this page your own.Inside your project, edit __AMEN_APP_NAME__/templates/index.html to start building your interface.