@koopjs/cli

@koopjs/cli

An easy-to-use CLI tool to quickly build Koop applications and plugins

Features

• follow Koop specification
• minimal project templates
• full development cycle support
• console commands + Node.js APIs
• cross-platform

Install

Use npm

npm install -g @koopjs/cli

Use yarn

yarn global add @koopjs/cli

Once installed the koop command is available at the console.

Example

Create a new Koop application with the name my-koop-app

# create a project folder and initialize it
koop new app my-koop-app

# cd in the folder
cd my-koop-app

Add a provider @koopjs/filesystem-s3 from npm

# install the provider and register it to the koop app
koop add provider @koopjs/filesystem-s3

Add a custom provider that connects to a local database

# add boilerplate provider files at src/providers/local-db and register it to
# the koop app (though you still need to implement the provider)
koop add provider providers/local-db --local

Test out your work

# run the koop server
koop serve

Commands

koop <command>

Commands:
  koop new <type> <name>  create a new koop project
  koop add <type> <name>  add a new plugin to the current app
  koop test               run tests in the current project
  koop serve              run a koop server for the current project

Options:
  --quiet    supress all console messages except errors
                                                      [boolean] [default: false]

new

The new command creates a new Koop project from the template at the current location.

koop new <type> <name>

Positionals:
  type  project type               [string] [choices: "app", "provider", "auth"]
  name  project name                                                    [string]

Options:
  --config        specify the project configuration in JSON             [string]
  --skip-install  skip dependence installation        [boolean] [default: false]
  --skip-git      do not initialize Git               [boolean] [default: false]

You can create different types of Koop projects from templates:

• app from koop-cli-new-app
• provider from koop-cli-new-provider
• auth from koop-cli-new-auth

For more details on the project templates, please take a look at the Koop specification and samples.

add

The add command adds a Koop plugin to the current Koop app.

koop add <type> <name>

Positionals:
  type  plugin type    [string] [choices: "output", "provider", "cache", "auth"]
  name  plugin name                                                     [string]

Provider Options:
  --route-prefix  add a prefix to all of a registered routes            [string]

Options:
  --local         add a plugin from a local path                      [string]
  --config        specify the plugin configuration in JSON              [string]
  --add-to-root   add the given configuration to the app root configuration
                                                      [boolean] [default: false]
  --skip-install  skip plugin installation            [boolean] [default: false]

serve

The serve command starts a test server for the current provider project, or starts the current Koop app.

koop serve

Options:
  --port, -p  port number of the server                                 [number]

test

The test command run tests in the current koop project.

koop test

APIs

This tool can be also used as a library.

const cli = require('@koopjs/cli')

// create a koop app project at /Documents
cli.new('/Documents', 'app', 'my-app', {
  config: {
    port: 8080
  }
})

new(cwd, type, name, [options])

Create a Koop project at the given directory.

• cwd: current work directory
• type: project type
• name: project name

Return a promise.

add(cwd, type, name, [options])

Add a plugin to the given Koop app

• cwd: Koop app directory
• type: project type
• name: Koop plugin name

Return a promise.