documentation/feisty_meow_command_reference.txt

   1
   2 Welcome, adventurous script user.
   3
   4 These are the handiest commands available in the Feisty Meow scripts.
   5 Note that each script is expected to be self-documenting.  Try running it
   6 with a "--help" flag (or with no parameters in some cases) to print the
   7 built-in docs.  At worst, you may have to read the script (that is a
   8 "documentation fail" on our part; please let us know).
   9
  10 setup and loading commands
  11 ==========================
  12
  13 + read "readme.txt" in the top of the feisty meow codebase, or
  14 + read it online at: https://feistymeow.org/feisty_meow/readme.txt
  15
  16 generally useful commands
  17 =========================
  18
  19   pwd:
  20   reports similarly to the good old system "pwd", but translates the $HOME
  21   variable into the '~' name.  e.g., if you're fred in /home/fred/turnips
  22   and you run 'pwd', then it will print: ~/turnips
  23
  24   i:
  25   take inventory.  prints out some time and relative dimension in space
  26   information and shows the current directory's contents.
  27
  28   dir or l (lower-case L):
  29   show the directory with a "summing" feature that calculates the full size
  30   consumed by all files in the listing, with somewhat esthetic output.
  31
  32   ll:
  33   like 'dir' but also includes hidden files (e.g. those starting with a dot).
  34
  35   ls:
  36   the standard ls command (not the summing directory), but with ls colors
  37   enabled.
  38
  39   del or rm:
  40   invoke "safedel" feature to remove the files specified.  this archives the
  41   deleted files in "$TMP/zz_safedel_keep" and writes a report of the deletion
  42   history in "$TMP/zz_safedel_report.txt".
  43
  44   note about safe deletion support:
  45   currently there is no "empty the trash" function aside from running a
  46   command such as:
  47     $ \rm -rf $TMP/zz_safedel*
  48   the backslash forces bash to run the "rm" tool from the path rather than
  49   using the feisty meow alias.  a trash flushing feature is planned for the
  50   somewhat near future.
  51
  52   regenerate:
  53   runs the feisty meow reconfiguration process to adapt to a new version of
  54   the scripts.  this also updates the current shell's functions and aliases
  55   to reflect any changes.
  56
  57   get_feisty:
  58   update the feisty meow codebase from its origin and run the regeneration
  59   script to update the current user's feisty meow configuration.
  60
  61   whackem:
  62   permanently delete files, rather than using safe delete (safedel).  this
  63   script will accept all the standard arguments to "rm".
  64
  65 revision control commands
  66 =========================
  67
  68 all revision control commands bring up the editor in the EDITOR environment
  69 variable when creating commit messages.  you need to actually save and quit
  70 from that editor when you're done writing your commit message.
  71
  72   here's a guide to writing good commit messages:
  73   + https://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message
  74
  75 ========
  76 the first suite of commands takes a list of directory names as parameters and
  77 then operates on those names.
  78 ========
  79
  80   rgetem:
  81   does a simple update (or pull) of the repository paths provided on the
  82   command line.  this will only get things from the main origin that the
  83   repository is hooked up with, so it is super quick compared to the next
  84   couple commands.
  85
  86   rpuffer:
  87   update the repositories provided on the command line by "puffing them out",
  88   which means that the upstream repositories that feed the local one will be
  89   synched up with it.  this is quite important to do when a git repository has
  90   multiple branches, since unmerged changes upstream can really snarl up your
  91   checkin.  this is basically a heavyweight version of rgetem.
  92
  93   rcheckin:
  94   checks in the list of repositories passed on the command line.  in git
  95   parlance, this adds all modified or untracked files, then commits all
  96   changes in the repository, and finally pushes up the changes to the remote
  97   online repository.  before doing the checkin, this will do a full "rpuffer"
  98   update on the repository to ensure that there are no unmerged upstream
  99   changes that could cause problems later.
 100
 101 ========
 102 the next suite of commands uses the REPOSITORY_LIST environment variable as
 103 the set of revision controlled folders to operate on.  the feisty meow scripts
 104 automatically add the feisty meow top-level (the apex) to this list to ensure
 105 that updates are received when available.
 106 ========
 107
 108   getem:
 109   update all repositories in the REPOSITORY_LIST from their upstream remote
 110   counterparts.  fast.
 111
 112   puffer:
 113   puffs out the REPOSITORY_LIST items to merge upstream changes.
 114
 115   checkin:
 116   checks in all changes in the REPOSITORY_LIST to their remote repositories.
 117
 118 ========
 119 some assorted other revision control commands:
 120 ========
 121
 122   feisty_branch:
 123   shows the current branch that is checked out.
 124
 125   this command will move your feisty meow codebase to the development branch:
 126   pushd $FEISTY_MEOW_APEX; git checkout dev; popd
 127
 128   and this command will get you back onto the mainline branch:
 129   pushd $FEISTY_MEOW_APEX; git checkout main; popd
 130
 131 =============================
 132 the site avenger script suite
 133 =============================
 134
 135 the site avenger tools (inherited from the avbash project) are commands for
 136 managing web sites.  these scripts offer a lot of power to the developer, and
 137 of course that comes with great responsibility...
 138
 139 the site avenger scripts are configured by "app" files stored in the "config"
 140 directory (in $FEISTY_MEOW_SCRIPTS/site_avenger/config).  the scripts
 141 seek out a config file named after the application, e.g. they look for
 142 "winterportlibrary.app" if the application name is "winterportlibrary".
 143 the basic config file "default.app" is used for any application that is unknown
 144 in the config directory.  any of the variable definitions provided in
 145 default.app can be overridden to change how the applications, and associated
 146 web site and domain, are configured.  see "mapsdemo.app" for an example of
 147 overriding the domain name for the mapsdemo application.
 148
 149   revamp_cakelampvm:
 150   establishes permissions and ownership to make the virtual machine and its
 151   services behave properly.  if something goes wonky, try running this script.
 152   this script is also the main vehicle for delivering configuration changes
 153   to the cakelampvm.  we are trying really hard to never release a version 2
 154   of the vm, since we can patch it as needed using the revamp script.  let's
 155   see how well that works out...
 156
 157   standup:
 158   brings up an application or web site from scratch (potentially) by creating
 159   an appropriate domain name, writing a basic apache site config file, pulling
 160   the application from a git repository, and "powering up" the application via
 161   composer.  this is most powerful and effective on php sites, but can also be
 162   used for other types of websites.  note that this, and all of the scripts
 163   here, are heavily biased for site avenger based development at saco designs.
 164   to make these scripts truly your own, write configuration files (see above)
 165   that define the proper folders and repository for your applications.
 166
 167   teardown:
 168   takes down a site previously brought up by the standup command.  this just
 169   eliminates the domain and the apache site though; the code is left in place
 170   to prevent disaster.
 171
 172   powerup:
 173   similar to standup, but just gets the application source out and powers it
 174   up with composer.
 175
 176 (note: automatic database configuration and inflation is in the pipeline for
 177 the powerup command, but is not ready yet.)
 178
 179   avcoreup:
 180   updates the avcore portion of a site avenger application.  this command can
 181   accept an application name within which to update, or it can auto-pick the
 182   application for you from the available checked out ones in ~/apps (the
 183   default storage folder for all site avenger style sites).
 184
 185   siteup:
 186   updates the entire checked out repository for a site avenger application.
 187   supports app name on the command line, or auto-picks the app.
 188
 189   sitepush:
 190   checks in the source code and other site assets for a site avenger app.
 191   supports passing an app name on the command line, or auto-picks the app.
 192
 193   satis-refresh:
 194   updates satis for a site(?).
 195
 196 note: satis-refresh is the one site avenger command that hasn't been "feisty meowicized" yet.
 197
 198 lower level scripts used by site avenger scripts
 199 ------------------------------------------------
 200
 201   add_domain and remove_domain: (from system script collection)
 202   adds (or removes) a DNS domain to the bind9 configuration.  the domain
 203   tools, are very sensitive to any edits within the chunks of code they have
 204   written.  when it comes time to remove the domain again, the script will eat
 205   the number of lines it expects to find after the beginning of the domain
 206   definition that it added.  to avoid any issues, if you need to edit the bind
 207   config files, be sure to do it way above or way below the auto-generated
 208   domain chunks.
 209
 210   add_apache_site and remove_apache_site: (from system script collection)
 211   creates (or removes) an apache compatible site definition.  this will rely
 212   on the site's domain previously having been added to the DNS.
 213
 214 note: currently we only implement the http site, but we're planning to add https support via self-signed certificates soon.
 215
 216