{"id":13505703,"url":"https://github.com/koopjs/koop-cli","last_synced_at":"2025-04-10T10:41:32.465Z","repository":{"id":34361675,"uuid":"158146030","full_name":"koopjs/koop-cli","owner":"koopjs","description":"CLI tool to build Koop applications and plugins","archived":false,"fork":false,"pushed_at":"2023-12-05T18:52:21.000Z","size":1845,"stargazers_count":11,"open_issues_count":8,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-24T09:38:14.601Z","etag":null,"topics":["cli","koop","koop-cli"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/koopjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2018-11-19T01:38:41.000Z","updated_at":"2023-04-03T06:14:10.000Z","dependencies_parsed_at":"2023-12-05T19:48:50.657Z","dependency_job_id":null,"html_url":"https://github.com/koopjs/koop-cli","commit_stats":{"total_commits":196,"total_committers":9,"mean_commits":21.77777777777778,"dds":0.6785714285714286,"last_synced_commit":"2d9c42e2b13e766a536bf06e6645cea002d8645d"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koopjs%2Fkoop-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koopjs%2Fkoop-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koopjs%2Fkoop-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koopjs%2Fkoop-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/koopjs","download_url":"https://codeload.github.com/koopjs/koop-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248199326,"owners_count":21063654,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","koop","koop-cli"],"created_at":"2024-08-01T00:01:11.920Z","updated_at":"2025-04-10T10:41:32.443Z","avatar_url":"https://github.com/koopjs.png","language":"JavaScript","funding_links":[],"categories":["Application generators and CLIs","Dev Tools"],"sub_categories":[],"readme":"# @koopjs/cli\n\n[![npm package](https://img.shields.io/npm/v/@koopjs/cli.svg)](https://www.npmjs.com/package/@koopjs/cli) [![Build Status](https://travis-ci.org/koopjs/koop-cli.svg?branch=master)](https://travis-ci.org/koopjs/koop-cli)\n\nAn easy-to-use CLI tool to quickly build [Koop](https://github.com/koopjs/koop) applications and plugins\n\n## Features\n\n* follow [Koop specification](https://koopjs.github.io/docs/usage/koop-core)\n* minimal project templates\n* full development cycle support\n* console commands + Node.js APIs\n* cross-platform\n\n## Install\n\nUse npm\n\n```\nnpm install -g @koopjs/cli\n```\n\nUse yarn\n\n```\nyarn global add @koopjs/cli\n```\n\nOnce installed the `koop` command is available at the console.\n\n## Example\n\nCreate a new Koop application with the name `my-koop-app`\n\n``` bash\n# create a project folder and initialize it\nkoop new app my-koop-app\n\n# cd in the folder\ncd my-koop-app\n```\n\nAdd a provider [@koopjs/filesystem-s3](https://github.com/koopjs/koop-filesystem-s3) from npm\n\n``` bash\n# install the provider and register it to the koop app\nkoop add provider @koopjs/filesystem-s3\n```\n\nAdd a custom provider that connects to a local database\n\n``` bash\n# add boilerplate provider files at src/providers/local-db and register it to\n# the koop app (though you still need to implement the provider)\nkoop add provider --local providers/local-db\n```\n\nTest out your work\n\n``` bash\n# run the koop server\nkoop serve\n```\n\n## Commands\n\n```\nkoop \u003ccommand\u003e\n\nCommands:\n  koop new \u003ctype\u003e \u003cname\u003e  create a new koop project\n  koop add \u003ctype\u003e \u003cname\u003e  add a new plugin to the current app\n  koop remove \u003cname\u003e      remove an existing plugin from the current app\n  koop list [type]        list plugins added to the current app\n  koop test               run tests in the current project\n  koop serve [path]       run a Koop server for the current project\n  koop validate           validte the current plugin\n\nOptions:\n  --quiet    supress all console messages except errors\n                                                      [boolean] [default: false]\n```\n\nEach 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).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoopjs%2Fkoop-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkoopjs%2Fkoop-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoopjs%2Fkoop-cli/lists"}