Gnar CLI

The easiest way to adorn your applications with Gnarly Opinions™

Usage

Gnar-cli can be installed most easily with brew:

$ brew tap TheGnarCo/gnar
$ brew install gnar

You can also use your favorite NPM package manager:

yarn global add gnar-cli
npm install -g gnar-cli

This will make the gnar executable available in your terminal.

Commands

There are two commands provided by Gnar-cli: init and add.

gnar init

You can use init to greenfield new projects with specific frameworks.

$ gnar init rails new-app

This is equivalent to running rails new new-app <gnarly config options here>.

Right now, init supports rails.

gnar add

You can use add to configure already-existing projects with specific configurations for specific dependencies.

$ gnar add eslint

This will add eslint to the package.json of the local project, as well as modifying it with Gnarly Opinions.

Right now, add supports eslint and prettier.

Configs

Configuration information and opinons for these commands are maintained by the .gnarrc repo. PR's Welcome!

Developing

Gnar-CLI is powered by TypeScript which means the project has to be compiled before being run.

1. Run yarn to install dependencies
2. Run yarn build:watch to start the TypeScript compiler in watch mode.
3. Run yarn dev to run the local build of the application

Publishing

See PUBLISHING.md

About The Gnar Company

The Gnar Company is a Boston-based development company that builds robust web and mobile apps designed for the long haul.

For more information see our website.