Commands

jstory offers a number of commands to build on the Jamstory platform.

• docs - Open these docs in your default browser
• version - Show version information for jstory
• init - Create a new project
• push - Push a script to Jamstory
• run - Run a script
• login - Authorize jstory with your Jamstory account
• logout - Remove jstory’s authorization for accessing your account
• signup - Create a Jamstory account

Note

You can use the --help flag (or -h for a shorter version) to display help information for any command.

docs

Open the Jamstory documentation in your browser.

jstory docs

version

Show version information for jstory.

jstory version

init

Create a new Jamstory project.

jstory init <PROJECT_NAME>

• PROJECT_NAME string (required)
  • The name of the project

push

Push a script to Jamstory.

jstory push <FILEPATH>

• FILEPATH string (required)
  • The path to the script file you want to push to Jamstory

run

Run a script on the Jamstory platform.

jstory run <SCRIPT_ID> [OPTIONS]

• SCRIPT_ID string (required)

  • The ID of the script you want to run

• OPTIONS:

  • -i, --input VALUE ...
    • Input parameters for the script
  • -d, --dry-run
    • Simulate running the script without actually running it

login

Authorize jstory with your Jamstory account.

jstory login

logout

Remove jstory’s authorization for your account.

jstory logout

signup

Create a Jamstory account. This will open your web browser.

jstory signup