https://github.com/feathersjs/cli

The command line interface for scaffolding Feathers applications
https://github.com/feathersjs/cli

Last synced: 3 months ago
JSON representation

The command line interface for scaffolding Feathers applications

• Host: GitHub
• URL: https://github.com/feathersjs/cli
• Owner: feathersjs-ecosystem
• License: mit
• Archived: true
• Created: 2016-03-25T15:35:47.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T22:00:38.000Z (about 2 years ago)
• Last Synced: 2024-05-18T21:55:30.666Z (8 months ago)
• Language: JavaScript
• Homepage: https://github.com/feathersjs/feathers
• Size: 1.95 MB
• Stars: 155
• Watchers: 9
• Forks: 27
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/contributing.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-feathersjs - @feathersjs/cli - feathers-logo.png) (Plugins / Utilities)

README

        
# Feathers CLI

> __Important:__ The Feathers CLI has been moved to the [cli package](https://github.com/feathersjs/feathers/tree/dove/packages/cli) in [feathersjs/feathers](https://github.com/feathersjs/feathers )

[![CI](https://github.com/feathersjs/cli/workflows/CI/badge.svg)](https://github.com/feathersjs/cli/actions?query=workflow%3ACI) ![Dependency status](https://david-dm.org/feathersjs/cli.svg)

The command line interface for Feathers applications

## Installation

```bash

npm install -g @feathersjs/cli

```

## Usage

```

$ mkdir myproject

$ cd myproject

$ feathers help

  Usage: feathers generate [type]

  Options:

    -V, --version  output the version number

    -h, --help     output usage information

  Commands:

    generate|g [type]  Run a generator. Type can be

    	• app - Create a new Feathers application in the current folder

    	• authentication - Set up authentication for the current application

    	• connection - Initialize a new database connection

    	• hook - Create a new hook

    	• middleware - Create an Express middleware

    	• service - Generate a new service

    	• plugin - Create a new Feathers plugin

    upgrade|u          Try to automatically upgrade to the latest Feathers version

    *

$ feathers generate app

$ npm start

```

## About

Feathers CLI's generators are provided by [generator-feathers](https://github.com/feathersjs/generator-feathers) and [generator-feathers-plugin](https://github.com/feathersjs/generator-feathers-plugin).

## License

Copyright (c) 2017

Licensed under the [MIT license](LICENSE).