@feathersjs/cli) is a command-line interface for generating and scaffolding Feathers applications. It provides interactive generators that create production-ready code following best practices.
What the CLI does
The Feathers CLI helps you:- Generate new applications - Create a complete Feathers application with your choice of framework (Express or Koa), database, authentication, and more
- Add services - Generate new services with database adapters (Knex, MongoDB, or custom)
- Create hooks - Scaffold hooks for your application logic
- Set up authentication - Add authentication with local and OAuth strategies
- Configure databases - Add database connections to your application
Available generators
The CLI includes the following generators:Interactive generators
The Feathers CLI uses interactive prompts to guide you through the generation process. Each generator asks relevant questions and creates the appropriate files and configuration.- Service name and path
- Database adapter type
- Schema definition
- And more
Command aliases
The CLI supports shorthand aliases for common commands:| Full command | Alias |
|---|---|
feathers generate | feathers g |
feathers generate app | feathers g app |
feathers generate service | feathers g service |
Generator options
Generators support command-line options to skip interactive prompts:Help and version
View help for any command:Generated code structure
The CLI generates TypeScript code following Feathers best practices:- Type-safe - Full TypeScript support with proper types
- Schema-first - Uses TypeBox or JSON Schema for validation
- Modular - Clean separation of concerns
- Production-ready - Includes error handling, logging, and configuration
Next steps
Installation
Install the Feathers CLI
Generate app
Create your first Feathers application