CLI#
For each command the gray box shows the usage.
These are documented according to bash/unix convention.
the
[]do not get used, they indicate that there might be more than one item in that position[OPTIONS]refers to any optional inputs or options[ARGS]refers to required inputs, or arguments
cspt#
cspt [OPTIONS] COMMAND [ARGS]...
badgecounts#
check if early bonus is met from output of gh pr list -s all –json title,latestReviews,createdAt and return a message. input from either a file or -for stdin
cspt badgecounts [OPTIONS] JSON_OUTPUT
Options
- -s, --soft#
soft check, skip title check
Arguments
- JSON_OUTPUT#
Required argument
combinecounts#
combine two yaml files by adding values
cspt combinecounts [OPTIONS] FILEA FILEB
Arguments
- FILEA#
Required argument
- FILEB#
Required argument
createtoyfiles#
from a yaml source file create a set of toy files with file names as the keys and the values as the content of each file
cspt createtoyfiles [OPTIONS] SOURCE_YAML
Options
- -n, --add-newline#
add new line as last character
Arguments
- SOURCE_YAML#
Required argument
earlybonus#
check if early bonus is met from output of gh pr list -s all –json title,latestReviews,createdAt and return a message. input from either a file or -for stdin
cspt earlybonus [OPTIONS] JSON_OUTPUT
Options
- -y, --output-yaml#
output as yaml compatible with grading
Arguments
- JSON_OUTPUT#
Required argument
exportac#
export ac files for site from lesson
cspt exportac [OPTIONS] LESSON_FILE
Options
- -d, --ac-date <ac_date>#
date to use for writing file out
- -p, --path <path>#
base path of where to save ac date files into subfolders
- --prepare#
do prepare (otherwise do review & practice)
Arguments
- LESSON_FILE#
Required argument
exporthandout#
export prismia version of the content
cspt exporthandout [OPTIONS] LESSON_FILE
Arguments
- LESSON_FILE#
Required argument
exportprismia#
export prismia version of the content
cspt exportprismia [OPTIONS] LESSON_FILE
Options
- -v, --debug#
Arguments
- LESSON_FILE#
Required argument
getassignment#
get the assignment text formatted
cspt getassignment [OPTIONS]
Options
- --type <assignment_type>#
type can be {prepare, review, or practice}; default prepare
- --date <date>#
date should be YYYY-MM-DD of the tasks you want; default most recently posted
getbadgedate#
cli for calculate badge date
cspt getbadgedate [OPTIONS]
Options
- --type <assignment_type>#
type can be prepare, review, or practice
- --prepare#
- --review#
- --practice#
grade#
calculate a grade from yaml that had keys of badges/bonuses and value for counts
cspt grade [OPTIONS] BADGE_FILE
Options
- -i, --influence#
return numerical instead of letter
- -v, --verbose#
print out all information
Arguments
- BADGE_FILE#
Required argument
issuestat#
cspt issuestat [OPTIONS] ISSUE_RESPONSE
Arguments
- ISSUE_RESPONSE#
Required argument
issuestatus#
generate script to appy course issue statuse updates
gh issue list –json title,number,labels
cspt issuestatus [OPTIONS] JSON_OUTPUT
Options
- -f, --file-out <file_out>#
to write to a file, otherwise stdout
- -r, --execute#
run instead of returning
- -d, --as-of-date <as_of_date>#
date for not current
Arguments
- JSON_OUTPUT#
Required argument
kwlcsv#
generate the activity file csv file for the site building from site located at the TLDPATH (directory of the top level of the course site)
cspt kwlcsv [OPTIONS] TLDPATH
Arguments
- TLDPATH#
Required argument
mkchecklist#
transform input file to a gh markdown checklist, if the first characters of eaech line are numbers, make them links
cspt mkchecklist [OPTIONS] GH_CLI_OUTPUT
Options
- -m, --message <message>#
messsage to prepend to output
Arguments
- GH_CLI_OUTPUT#
Required argument
parsedate#
process select non dates
cspt parsedate [OPTIONS] PASSED_DATE
Arguments
- PASSED_DATE#
Required argument
prfixlist#
check json output for titles that will not be counted as a badge this will include gh pr list -s all –json title,latestReviews
cspt prfixlist [OPTIONS] JSON_OUTPUT
Arguments
- JSON_OUTPUT#
Required argument
processexport#
transform output from mac terminal export to myst notebook (relies on regex specifically to brownsarahm)
cspt processexport [OPTIONS]
Options
- -d, --date-in <date_in>#
date part of filename to read in
- -p, --base-path <base_path>#
path that contains the notes folder
progressreport#
list PR titles from json or - to use std in that have been approved by an official approver
gh pr list -s all –json title,latestReviews
cspt progressreport [OPTIONS] JSON_OUTPUT
Options
- -f, --file-out <file_out>#
to write to a file, otherwise will use stdout
- -r, --report#
process approved badges by type to a more descriptive report
- -s, --soft#
soft check, skip title check
- -b, --brief#
short version of report
Arguments
- JSON_OUTPUT#
Required argument
titlecheck#
check a single title
cspt titlecheck [OPTIONS]
Options
- -t, --pr-title <pr_title>#
title to check as string
- -g, --ghpr <ghpr>#
pass title as file, or gh pr view output through pipe