ALEMBIC(1)
β¨ ALEMBIC(1) β User Commands β¨
π NAME
alembic β manual page for alembic 1.19.2 π¦
πΈ SYNOPSIS
okay so here's the vibe for calling it π
usage: -c [-h] [--version] [-c CONFIG] [-n NAME] [-x X] [--raiseerr]
[-q]
{branches,check,current,downgrade,edit,ensure_version,heads,history,init,list_templates,merge,revision,show,stamp,upgrade}
...
π DESCRIPTION
bestie, this is the usage line, and it's giving "pick a subcommand and go" π§ Here's the full menu of subcommands you can pick from π
{branches,check,current,downgrade,edit,ensure_version,heads,history,init,list_templates,merge,revision,show,stamp,upgrade}
π positional arguments
{branches,check,current,downgrade,edit,ensure_version,heads,history,init,list_templates,merge,revision,show,stamp,upgrade}
π branches
Show current branch points. It's literally where the revisions split up, so you can see the forks in the road β¨
π check
Check if revision command with autogenerate has pending upgrade ops. Basically it checks whether your revision --autogenerate has upgrade stuff hanging around that still needs doing π
π· current
Display the current revision for a database. Tells you where your database is at right now π«Ά
π downgrade
Revert to a previous version. Rewinding the clock on your schema π°οΈ
π¦ edit
Edit revision script(s) using $EDITOR. It opens your revision scripts in whatever editor you've got set up π
π ensure_version
Create the alembic version table if it doesn't exist already . Makes the version table if it isn't there yet, and does nothing if it already is π
πΏ heads
Show current available heads in the script directory. The latest revision tips in your scripts folder π
π history
List changeset scripts in chronological order. Your whole migration timeline, oldest to newest ποΈ
πͺ init
Initialize a new scripts directory. Sets up a brand new scripts folder from scratch β¨
π§ list_templates
List available templates. Shows you what starter templates you can work with π¨
π merge
Merge two revisions together. Creates a new migration file. Two branches come together and a new migration file is born π«Ά
πΊ revision
Create a new revision file. Makes a fresh migration file for you π«
π show
Show the revision(s) denoted by the given symbol. Pulls up the revision (or revisions) you point at π
π stamp
'stamp' the revision table with the given revision; don't run any migrations. Marks the revision table as being at the revision you give it, but ngl it does NOT actually run any migrations π
ββοΈ
π upgrade
Upgrade to a later version. Moving your schema forward π₯
π options
πΈ -h, --help
show this help message and exit πββοΈ
π
--version
show program's version number and exit π
π¦ -c, --config CONFIG
Alternate config file. Defaults to the value of the ALEMBIC_CONFIG environment variable, or "alembic.ini". It can also point at a pyproject.toml file. You can specify it twice to reference both files separately π§
π -n, --name NAME
Name of section in .ini file to use for Alembic config (only applies to configparser config, not toml) π·
π -x X
Additional arguments consumed by custom env.py scripts, e.g. -x setting1=somesetting -x setting2=somesetting π
π --raiseerr
Raise a full stack trace on error. If something breaks, you get the whole dramatic stack trace π
β -q, --quiet
Do not log to std output. Keeps the terminal quiet, no logs printed to stdout π€«
β οΈ Heads up bestie: the --raiseerr flag gives you a full stack trace on error, so it's the one to reach for when you need the nitty-gritty details π
Sign-off: That's the tea for alembic 1.19.2 from the September 2026 docs π Stay iconic, bestie β¨π«Ά
π¦ where this page comes from
- fedora 43: python3-alembic 1.19.2-1.fc43 Β· MIT
- fedora 44: python3-alembic 1.19.2-1.fc44 Β· MIT
- π girlified by claude-haiku-5-5 on : a language model's rewrite of the original, under its terms