# @ronin/cli

> The command-line interface for RONIN.

Latest version **0.3.20** (published 2025-06-15) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @ronin/cli
pnpm add @ronin/cli
yarn add @ronin/cli
bun add @ronin/cli
```

## Health

**Score 40/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.20 |
| Published | 2025-06-15 |
| First published | 2024-12-18 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 11 |
| Unpacked size | 84.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | ronin |
| Maintainers | juriadams, leo, codenn, nurodev |
| Keywords | database, sql, command-line |

## Links

- npm: https://www.npmjs.com/package/@ronin/cli
- npm.io page: https://npm.io/package/@ronin/cli

## Dependencies (11)

- [ini](https://npm.io/package/ini.md) 5.0.0
- [ora](https://npm.io/package/ora.md) 8.1.1
- [open](https://npm.io/package/open.md) 10.1.0
- [json5](https://npm.io/package/json5.md) 2.2.3
- [get-port](https://npm.io/package/get-port.md) 7.1.0
- [@iarna/toml](https://npm.io/package/@iarna/toml.md) 2.2.5
- [resolve-from](https://npm.io/package/resolve-from.md) 5.0.0
- [chalk-template](https://npm.io/package/chalk-template.md) 1.1.0
- [@dprint/formatter](https://npm.io/package/@dprint/formatter.md) 0.4.1
- [@inquirer/prompts](https://npm.io/package/@inquirer/prompts.md) 7.2.3
- [@dprint/typescript](https://npm.io/package/@dprint/typescript.md) 0.93.3

## Alternatives

- [@libsql/sqlite3](https://npm.io/package/@libsql/sqlite3.md) — 39.8K weekly downloads
- [@fortemi/core](https://npm.io/package/@fortemi/core.md) — 461 weekly downloads
- [cdb-converter](https://npm.io/package/cdb-converter.md) — 341 weekly downloads
- [@uplo/adapter-prisma](https://npm.io/package/@uplo/adapter-prisma.md) — 75 weekly downloads
- [typeorm-aios](https://npm.io/package/typeorm-aios.md) — 30 weekly downloads

## Recent versions

- 0.3.20 (latest) — 2025-06-15
- 0.3.19-compiler-experimental-291 (compiler-experimental-291) — 2025-06-15
- 0.3.19-compiler-experimental-290 (compiler-experimental-290) — 2025-06-15
- 0.3.19-compiler-experimental-289 (compiler-experimental-289) — 2025-06-15
- 0.3.19-compiler-experimental-288 (compiler-experimental-288) — 2025-06-15
- 0.3.19-compiler-experimental-287 (compiler-experimental-287) — 2025-06-15
- 0.3.19-compiler-experimental-286 (compiler-experimental-286) — 2025-06-15
- 0.3.19-compiler-experimental-285 (compiler-experimental-285) — 2025-06-15
- 0.3.18-corny-types-experimental-284 (corny-types-experimental-284) — 2025-06-06
- 0.3.17-corny-pragma-experimental-283 (corny-pragma-experimental-283) — 2025-06-06
- 0.3.17-corny-pragma-experimental-282 (corny-pragma-experimental-282) — 2025-06-06
- 0.3.17-corny-pragma-experimental-281 (corny-pragma-experimental-281) — 2025-06-06
- 0.3.17-corny-correctly-move-data-experimental-280 (corny-correctly-move-data-experimental-280) — 2025-06-06
- 0.3.16-codegen-experimental-279 (codegen-experimental-279) — 2025-06-03
- 0.3.16-codegen-experimental-278 (codegen-experimental-278) — 2025-06-03
- … 336 more at https://npm.io/package/@ronin/cli/versions

## README

# RONIN CLI

[![tests](https://img.shields.io/github/actions/workflow/status/ronin-co/cli/validate.yml?label=tests)](https://github.com/ronin-co/cli/actions/workflows/validate.yml)
[![code coverage](https://img.shields.io/codecov/c/github/ronin-co/cli)](https://codecov.io/github/ronin-co/cli)
[![install size](https://packagephobia.com/badge?p=@ronin/cli)](https://packagephobia.com/result?p=@ronin/cli)

This package exposes the `ronin` command, which you can run from your terminal to interact with [RONIN](https://ronin.co).

## Setup

You don't need to install this package explicitly, as it is already included in the [RONIN client](https://github.com/ronin-co/client).

However, we would be excited to welcome your feature suggestions or bug fixes for the RONIN CLI. Read on to learn more about how to suggest changes.

## Contributing

To start contributing code, first make sure you have [Bun](https://bun.sh) installed, which is a JavaScript runtime.

Next, [clone the repo](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) and install its dependencies:

```bash
bun install
```

Once that's done, link the package to make it available to all of your local projects:

```bash
bun link
```

Inside the [@ronin/client](https://github.com/ronin-co/client) repo (which imports `@ronin/cli` and registers it as an executable), you can then run the following command, which is similar to `bun add @ronin/cli` or `npm install @ronin/cli`, except that it doesn't install `@ronin/cli` from npm, but instead uses your local clone of the package:

```bash
bun link @ronin/cli
```

### Transpilation

In order to be compatible with a wide range of projects, the source code of the `cli` repo needs to be compiled (transpiled) whenever you make changes to it. To automate this, you can keep this command running in your terminal:

```bash
bun run dev
```

Whenever you make a change to the source code, it will then automatically be transpiled again.

### Running Tests

The RONIN CLI has 100% test coverage, which means that every single line of code is tested automatically, to ensure that any change to the source code doesn't cause a regression.

Before you create a pull request on the `cli` repo, it is therefore advised to run those tests in order to ensure everything works as expected:

```bash
# Run all tests
bun test

# Alternatively, run a single test
bun test -t 'your test name'
```

---
_Source: https://npm.io/package/@ronin/cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
