Skip to content

Command Line Options

Jump to bottom
Colin Robbins edited this page Aug 30, 2020 · 8 revisions

The SCM command line interface takes a set of options, using the linux double-dash -- convention.

scm <options>

Where...

  • -h

  • --help

    Print a help message

  • --analyse

    Run analysis on archive instead of contacting SCM. Specify the date of the backup in yyyy-mm-dd format. e.g., 2020-04-07. Also use to specify which archive to use on --restore options.

  • --backup

    Create an encrypted [backup](Backup and Restore) of SCM. The encrypted files are stored in the backups folder.

  • --coaches

    A simple report on the coaches for each session.

  • --confirm_email

    A report the prints the email address of everyone that has not confirmed their details if SCM (or they have expired)

  • —-covid

    A report on members in swim sessions and wether they have the required COVID code of conduct.

  • --csv

    Read a CSV file, and compare the content with SCM. Main use case is to compare a download of club membership records from Swim England with SCM. You will need to edit the configuration file to specify the CSV contents and checks required. See [Swim England](Swim England) for more details

  • --dump

    Dump SCM contents of type in clear text. e.g., scm --dump members, or scm -dump groups. By default it will be in JSON format. Use --format to specify something else.

  • --error

    Print issues identified in SCM, group by error type. This is the default behaviour of scm if no other parameters are supplied.

  • --facebook

    Check Facebook group members are club members. This is a bit tricky to set up - see Facebook.

  • -f

  • -fix

    Some errors can be automatically fixed. Run scm --fix to fix them - you will be prompted to confirm each fix. See fixing for more details

  • --format

    The format to use with the --dump option. E.g., scm --dump lists --format CSV

  • -l

  • -lists

    Creates a set of email lists in SCM, based on the search configuration defined in configuration. See email lists for more details

  • -m

  • --member

    Print issues identified grouped by member, rather an error.

  • --newstarter

    Include new starters in the report. These are normally suppressed for 90 days, to allow time for everything to be set up.

  • --newtimes

    Load new swim times and compare against Records. File should be exported from SCM.

  • --notes

    The tools search the SCM notes field to look for details of any allowable issues for the member. This option prints out the list of exceptions. See exceptions for details.

  • -q

  • --quiet

    Quiet, will not print commentary on what it is doing - useful if using scm in a script

  • **--records

    Process swimming [Records]

  • --report

    By default scm reports in everything. You can specify specific reports. For example scm --report groups

  • --restore

    Restore an entity of from backup. You will be asked for the name of the entry, and to confirm the restore. You need to specify a backup file with --archive as well. e.g., scm --restore member --archive 2020-03-14 See [Backup and Restore](Backup and Restore) for more details

  • **--se

    Check against Swim England Database online

  • --verify

    Having done a backup, you can verify it. This will run a basic set of checks to confirm the data can be decrypted and read. (--archive is exactly the same!)

  • --email

    Send the output via email, as per configuration. Can specify who to with --to

  • --to

    The email address(es) to send the email to. For multiple recipients, separate them with a ';'. No spaces.

Clone this wiki locally