@githubtraining/github-exercise-manager NPM

npm (scoped)

GitHub Exercise Manager

A command line tool used to quickly scaffold the files needed to create an exercise using Actions on GitHub.

Basic Usage

npx @githubtraining/github-exercise-manager <command> <parameters> [options]

Create an exercise in the current directory named bread

npx @githubtraining/github-exercise-manager new-exercise bread

Create an exercise named bread in a different project directory

npx @githubtraining/github-exercise-manager new-exercise bread -p ~/projects/my-project

Create an exercise named bread that uses Looking Glass version 4 and sets the GitHub repository mona/my-exercise as upstream

npx @githubtraining/github-exercise-manager new-exercise bread -v 4 -o mona -r my-exercise

Commands | Command | Description | | ------------------ | ----------------------------------- | | new-exercise | Scaffolds a new exercise |

CLI Parameters

Parameter	Description	Required	Templating Keyword
`<exercise-title>`	Name of the exercise being authored	Yes	`title`

CLI Flags

Flag	Description	Default Value	Templating Keyword
`-a`, `--action-name`	User defined name for the local action of the exercise	local-action	`actionName`
`-o`, `--github-owner`	Username or organization that has ownership of the desired exercise repository	Empty	`githubOwner`
`-p`, `--project-path`	Path where the exercise will be created	Current directory	`projectPath`
`-r`, `--github-repository`	Name of the exercise repository	Empty	`githubRepository`
`-v`, `--lg-version`	Looking Glass version you wish to use in the grading.yml exercise file"	Latest release of Looking Glass	`lgVersion`