https://github.com/moduscreateorg/modus-cli

Modus CLI tools
https://github.com/moduscreateorg/modus-cli

Last synced: 3 months ago
JSON representation

Modus CLI tools

• Host: GitHub
• URL: https://github.com/moduscreateorg/modus-cli
• Owner: ModusCreateOrg
• License: mit
• Created: 2018-05-21T18:13:23.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-04-24T20:51:07.000Z (about 2 years ago)
• Last Synced: 2025-03-12T23:05:09.966Z (3 months ago)
• Language: JavaScript
• Size: 223 KB
• Stars: 0
• Watchers: 16
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
[![Modus CLI Tools](./images/modus.logo.svg)](https://moduscreate.com)

# Modus CLI Tools

[![MIT Licensed](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/your/your-project/blob/master/LICENSE)

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

## Installing

Download `modus` CLI from npm or yarn.

```shell

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+.

```shell

git clone [email protected]:ModusCreateOrg/modus-cli.git

cd modus-cli/

npm install

```

## Api Reference

### Guidelines

Add Modus guidlines repo files to current directory

```shell

modus guidelines

```

Usage: guidelines [options]

Add Modus guidelines repo files to current directory

Options:

* `-r, --repo `  Set remote repo (org/repo/branch), defaults to ModusCrteateOrg/guidelines/master (default:ModusCreateOrg/guidelines/master)

* ` -d, --dest `   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](https://moduscreate.com) 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](./images/modus.logo.svg)](https://moduscreate.com)

## Licensing

This project is [MIT licensed](./LICENSE).