diff --git a/docs/abra/cheat-sheet.md b/docs/abra/cheat-sheet.md new file mode 100644 index 0000000..65c96a6 --- /dev/null +++ b/docs/abra/cheat-sheet.md @@ -0,0 +1,52 @@ +--- +tags: coop-cloud +--- + +# Abra cheat sheet + +!!! info + not all flags are listed here. + +!!! warning + Definitely set up autocomplete or you'll be sad + + `abra autocomplete bash/zsh/fizsh` + +### create and deploy a new app: +- `abra app new $RECIPE` +flags: `-s/--server`, `-D/--domain`, `-S/--secrets`, `-p/--pass` +- `abra app config $APPNAME` +- `abra app secret generate $APPNAME -a` +flags: `-p/--pass`, `-a/--all` +- `abra app deploy $APPNAME` +flags: `-f/--force`, `-C/--chaos` + +### undeploy and remove an app +- back up any data you don't want to lose +- `abra app undeploy $APPNAME` +- `abra app rm --volumes $APPNAME` +flags: `-f/--force`, `-V/--volumes` + +### add/remove server +- `abra server add $SERVER $USERNAME $SSH_PORT` +flags: `-p/--provision`, `-l/--local` +- `abra server remove $SERVER` +flags: `-s/--server` + +### upgrade abra +- `abra upgrade` +flags: `--rc` + +### upgrade a recipe +- `abra recipe upgrade $RECIPE` +flags: `-x,y,z/--major,minor,patch` +- `abra recipe sync $RECIPE` +flags: `-x,y,z` +- `abra recipe release $RECIPE [$VERSION]` +flags: `-p/--publish`, `-r/--dry-run`, `-x,y,z` + +### make a change to a recipe +- edit the files in `~/.abra/recipe/$RECIPENAME` +- deploy the changed version to your test instance +- determine how serious your change is (semver.org for reference) +- `abra recipe release $RECIPE [$VERSION]` diff --git a/mkdocs.yml b/mkdocs.yml index a1d0388..6d778fd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -66,6 +66,7 @@ nav: - "Upgrade": abra/upgrade.md - "Hack": abra/hack.md - "Troubleshoot": abra/trouble.md + - "Cheat Sheet": abra/cheat-sheet.md - "Get Involved": - get-involved/index.md - "Glossary":