USAGE:(1)

πŸ“¦
version 9.0.0 Β· 4 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

okay bestie, sit down, hydrate, because we're reading the manual page for usage: β€” yes the name literally has a colon in it, iconic, no notes πŸ’… β€” aka the database schema migration tool we all know and love. she handles your migrations, she's got nine little subcommands, and she's about to make your schema behave. let's go πŸ¦‹βœ¨

🌸 NAME 🌸

usage: β€” Database schema migration tool πŸ’–


✨ DESCRIPTION ✨

so the vibe is: you type yoyo and then some stuff, and it does migration things. here's the full shape of it, exactly how it shows up:

usage: yoyo [-h] [--config CONFIG] [-v] [-b] [--no-config-file]
              {init,apply,develop,list,rollback,reapply,mark,unmark,break-lock,new}
              ...

that's the whole menu, bestie. below it the page breaks everything into positional arguments and options, so let's take them one at a time 🫢

πŸŽ€ positional arguments πŸŽ€

the group itself is described on the page as Commands help, and these are your choices:

{init,apply,develop,list,rollback,reapply,mark,unmark,break-lock,new}
  • init β€” spins up a brand new project for you ✨
  • apply β€” applies your migrations, that's it, that's the job πŸ’…
  • develop β€” applies migrations and does not prompt you at all. and if there's literally nothing unapplied sitting around? it reapplies the last migration instead. she's proactive like that 😭
  • list β€” shows you every migration, available and applied both. each line gets a little prefix so you can tell them apart: A means applied, U means unapplied πŸ‘‘
  • rollback β€” rolls your migrations back, rewinding the timeline βͺ
  • reapply β€” rolls back and then reapplies. a full little glow-up cycle πŸ¦‹
  • mark β€” marks migrations as applied without actually running them. sneaky. we love her πŸ™ˆ
  • unmark β€” the opposite: unmarks applied migrations without rolling them back πŸŽ€
  • break-lock β€” breaks migration locks, for when something got stuck holding the door πŸ”“
  • new β€” creates a new migration, fresh out the box ⭐

πŸ’… options πŸ’…

  • -h, --help β€” shows this help message and exits. the classic escape hatch 🫢
  • --config, -c CONFIG β€” tells her where the config file lives πŸ“
  • -v β€” verbose output! and you can stack it β€” use it multiple times to crank the verbosity level up and up and up πŸ”₯
  • -b, --batch β€” batch mode. this turns off every single user prompt, so she just goes πŸ‘‘
  • --no-config-file, --no-cache β€” don't go looking for a yoyo.ini config file 🚫

ok so real talk: the page then repeats the entire positional arguments block and the entire options block, word for word. not a typo on my end, bestie, that's literally what's printed. so here it is again, because we keep every detail πŸ’–

πŸŽ€ positional arguments (yes, again) πŸŽ€

{init,apply,develop,list,rollback,reapply,mark,unmark,break-lock,new}

described on the page as Commands help.

  • init β€” Initialize a new project ✨
  • apply β€” Apply migrations πŸ’…
  • develop β€” Apply migrations without prompting. If there are no unapplied migrations, reapply the last migration 😭
  • list β€” List all available and applied migrations. Each listed migration is prefixed with either A (applied) or U (unapplied) πŸ‘‘
  • rollback β€” Rollback migrations βͺ
  • reapply β€” Rollback then reapply migrations πŸ¦‹
  • mark β€” Mark migrations as applied, without running them πŸ™ˆ
  • unmark β€” Unmark applied migrations, without rolling them back πŸŽ€
  • break-lock β€” Break migration locks πŸ”“
  • new β€” Create a new migration ⭐

πŸ’… options (yes, again) πŸ’…

  • -h, --help β€” show this help message and exit 🫢
  • --config, -c CONFIG β€” Path to config file πŸ“
  • -v β€” Verbose output. Use multiple times to increase level of verbosity πŸ”₯
  • -b, --batch β€” Run in batch mode. Turns off all user prompts πŸ‘‘
  • --no-config-file, --no-cache β€” Don't look for a yoyo.ini config file 🚫

and that's the whole page, bestie, we read all of it, nothing skipped, we ate πŸ’–

one last thing before you go β€” the footer on this one reads usage: yoyo [-h] [--config CONFI... with the date May 2025, so that's your version-ish line and your timestamp, right at the bottom where footers live. go migrate something gorgeous πŸŒΈβœ¨πŸ¦‹

πŸ“¦ where this page comes from