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