sea-orm-cli is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing `sea` `sea-orm-cli` executables

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install sea-orm-cli

It will make sea sea-orm-cli commands available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall sea-orm-cli uninstalls.

Adding `sea_orm_cli` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add sea-orm-cli

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

sea-orm-cli = "2.0.0-rc.30"

The sea_orm_cli library will be automatically available globally. Read the sea_orm_cli library documentation.

Back to the crate overview.

Readme

SeaORM CLI

Install and Usage:

> cargo install sea-orm-cli 
> sea-orm-cli help

Or:

> cargo install --bin sea
> sea help

Getting Help:

cargo run -- -h

Running Entity Generator:

# MySQL (`--database-schema` option is ignored)
cargo run -- generate entity -u mysql://sea:sea@localhost/bakery -o out

# SQLite (`--database-schema` option is ignored)
cargo run -- generate entity -u sqlite://bakery.db -o out

# PostgreSQL
cargo run -- generate entity -u postgres://sea:sea@localhost/bakery -s public -o out

Running Migration:

Initialize migration directory
```
cargo run -- migrate init
```

Generate a new migration file

cargo run -- migrate generate MIGRATION_NAME

Apply all pending migrations

cargo run -- migrate

cargo run -- migrate up

Apply first 10 pending migrations
```
cargo run -- migrate up -n 10
```
Rollback last applied migrations
```
cargo run -- migrate down
```
Rollback last 10 applied migrations
```
cargo run -- migrate down -n 10
```
Drop all tables from the database, then reapply all migrations
```
cargo run -- migrate fresh
```
Rollback all applied migrations, then reapply all migrations
```
cargo run -- migrate refresh
```
Rollback all applied migrations
```
cargo run -- migrate reset
```
Check the status of all migrations
```
cargo run -- migrate status
```

Installing sea sea-orm-cli executables

Adding sea_orm_cli library as a dependency

Installing `sea` `sea-orm-cli` executables

Adding `sea_orm_cli` library as a dependency