https://github.com/koopjs/koop-cli
CLI tool to build Koop applications and plugins
https://github.com/koopjs/koop-cli
cli koop koop-cli
Last synced: 7 months ago
JSON representation
CLI tool to build Koop applications and plugins
- Host: GitHub
- URL: https://github.com/koopjs/koop-cli
- Owner: koopjs
- License: other
- Created: 2018-11-19T01:38:41.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-05T18:52:21.000Z (almost 2 years ago)
- Last Synced: 2025-03-24T09:38:14.601Z (8 months ago)
- Topics: cli, koop, koop-cli
- Language: JavaScript
- Homepage:
- Size: 1.76 MB
- Stars: 11
- Watchers: 4
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-arcgis-developers - koop-cli - Tool to scaffold Koop applications and plugins. (Application generators and CLIs)
README
# @koopjs/cli
[](https://www.npmjs.com/package/@koopjs/cli) [](https://travis-ci.org/koopjs/koop-cli)
An easy-to-use CLI tool to quickly build [Koop](https://github.com/koopjs/koop) applications and plugins
## Features
* follow [Koop specification](https://koopjs.github.io/docs/usage/koop-core)
* 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`
``` bash
# 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](https://github.com/koopjs/koop-filesystem-s3) from npm
``` bash
# 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
``` bash
# 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 --local providers/local-db
```
Test out your work
``` bash
# run the koop server
koop serve
```
## Commands
```
koop
Commands:
koop new create a new koop project
koop add add a new plugin to the current app
koop remove remove an existing plugin from the current app
koop list [type] list plugins added to the current app
koop test run tests in the current project
koop serve [path] run a Koop server for the current project
koop validate validte the current plugin
Options:
--quiet supress all console messages except errors
[boolean] [default: false]
```
Each command comes with the corresponding node.js API and this CLI can be used as a library. For detail information, please read the [command documentations](/docs/commands).