| 1 | # sequelize/cli [](https://badge.fury.io/js/sequelize-cli) [](https://travis-ci.org/sequelize/cli) [](https://greenkeeper.io/)
|
| 2 |
|
| 3 | The Sequelize Command Line Interface (CLI)
|
| 4 |
|
| 5 | ## Table of Contents
|
| 6 | - [Installation](#installation)
|
| 7 | - [Contributing](#contributing)
|
| 8 | - [Documentation](#documentation)
|
| 9 |
|
| 10 | ## Installation
|
| 11 |
|
| 12 | ### Globally
|
| 13 | Install CLI globally with
|
| 14 |
|
| 15 | ```bash
|
| 16 | $ npm install -g sequelize-cli
|
| 17 | ```
|
| 18 |
|
| 19 | Now you can run CLI using following command anywhere
|
| 20 |
|
| 21 | ```bash
|
| 22 | $ sequelize
|
| 23 | ```
|
| 24 |
|
| 25 | ### Locally
|
| 26 | Install CLI locally to your `node_modules` folder with
|
| 27 |
|
| 28 | ```bash
|
| 29 | $ npm install --save sequelize-cli
|
| 30 | ```
|
| 31 |
|
| 32 | You should be able to run CLI with
|
| 33 |
|
| 34 | ```bash
|
| 35 | $ node_modules/.bin/sequelize
|
| 36 | ```
|
| 37 |
|
| 38 | ### Usage
|
| 39 | ```
|
| 40 | Sequelize CLI [Node: 6.11.2, CLI: 3.0.0, ORM: 4.8.0]
|
| 41 |
|
| 42 | Commands:
|
| 43 | db:migrate Run pending migrations
|
| 44 | db:migrate:schema:timestamps:add Update migration table to have timestamps
|
| 45 | db:migrate:status List the status of all migrations
|
| 46 | db:migrate:undo Reverts a migration
|
| 47 | db:migrate:undo:all Revert all migrations ran
|
| 48 | db:seed Run specified seeder
|
| 49 | db:seed:undo Deletes data from the database
|
| 50 | db:seed:all Run every seeder
|
| 51 | db:seed:undo:all Deletes data from the database
|
| 52 | db:create Create database specified by configuration
|
| 53 | db:drop Drop database specified by configuration
|
| 54 | init Initializes project
|
| 55 | init:config Initializes configuration
|
| 56 | init:migrations Initializes migrations
|
| 57 | init:models Initializes models
|
| 58 | init:seeders Initializes seeders
|
| 59 | migration:generate Generates a new migration file [aliases: migration:create]
|
| 60 | model:generate Generates a model and its migration [aliases: model:create]
|
| 61 | seed:generate Generates a new seed file [aliases: seed:create]
|
| 62 |
|
| 63 | Options:
|
| 64 | --version Show version number [boolean]
|
| 65 | --help Show help [boolean]
|
| 66 | ```
|
| 67 |
|
| 68 | ## Contributing
|
| 69 |
|
| 70 | Sequelize CLI is always looking for contributions. You can help us with fixing bugs, reporting bugs or improving documentation.
|
| 71 |
|
| 72 | Please read [contributing documentation](CONTRIBUTING.md)
|
| 73 |
|
| 74 | ## Documentation
|
| 75 |
|
| 76 | - [Migrations Documentation](http://docs.sequelizejs.com/manual/tutorial/migrations.html)
|
| 77 | - [CLI Options](docs/README.md)
|
| 78 | - [Frequently Asked Questions](docs/FAQ.md)
|