Occam Open-CLI

Occam's command line package management tool.

This readme file is mostly for developers. For instructions tailored to end users, see the following:

https://openmathematics.org/how-to-contribute

Contents

• Installation
• Usage
• Building
• Contact

Installation

If you would like to contribute or would simply like to have a look at the code, you can clone the repository with Git...

git clone https://github.com/djalbat/occam-open-cli.git

...and then install the dependencies with npm from within the project's root directory:

npm install

Usage

These are the commands and options:

  open [<command>] [<argument>]

Commands:

  help                                           Show this help
  
  version                                        Show the version

  [install] <package_name>                       Install a package

  initialise                                     Create a configuration file

  set-options                                    Set options 

  clone <package_name>                           Clone a package with Git

  publish <package_name>                         Publish a package

  withdraw <package_name>                        Withdraw a package

  create-account [<email_address>]               Create an account
   
  sign-in [<email_address_or_username>]          Sign in 

  sign-out                                       Sign out 

  reset-password [<email_address>]               Reset password 

  set-shell-commands                             Set shell commands 

Options:

  --help|-h                                      Show this help

  --version|-v                                   Show the version

  --quietly|-q                                   Run with almost no console logging

  --log-level|-l                                 Set the log level when publishing
  
  --yes|-y                                       Initially answer yes to prompts

  --tail|-t                                      Sets the size of the tail of the log messages when publishing. The default is ten. 

  --follow|-f                                    Show all of the log messages when publishing. The default is false.

This is slightly different from npm in that open is usually executed from the parent directory of a project rather than from within the project sub-directory itself.

Building

Automation is thanks to npm scripts, have a look at the package.json file. The pertinent commands are:

npm run build-debug
npm run watch-debug

Contact

• [email protected]