Skip to content

ModusCreateOrg/modus-cli

Repository files navigation

Modus CLI Tools

Modus CLI Tools

MIT Licensed

Useful utility functions for working with high-profile applications and open source software.

Installing

Download modus CLI from npm or yarn.

npm -g install @modus/cli

Setting up Dev

This project is written in Node.js. It's recommended that you use it with Node 8.x+.

git clone git@github.com:ModusCreateOrg/modus-cli.git
cd modus-cli/
npm install

Api Reference

Guidelines

Add Modus guidlines repo files to current directory

modus guidelines

Usage: guidelines [options]

Add Modus guidelines repo files to current directory

Options:

  • -r, --repo <path> Set remote repo (org/repo/branch), defaults to ModusCrteateOrg/guidelines/master (default:ModusCreateOrg/guidelines/master)
  • -d, --dest <dir> Set destination directory for files. Defaults to . (default: .)
  • -s, --samples Include .sample. files from repo
  • -o, --overwrite Overwrite existing files from remote repository. Otherwise, downloaded files that would overwrite are saved as filename.modus.
  • -h, --help output usage information

Modus Create

Modus Create is a digital product consultancy. We use a distributed team of the best talent in the world to offer a full suite of digital product design-build services; ranging from consumer facing apps, to digital migration, to agile development training, and business transformation.

Modus Create

Licensing

This project is MIT licensed.

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •