# @aragon/cli

> Aragon command-line tools

Latest version **7.1.6** (published 2020-06-24) · GPL-3.0-or-later license · 0 weekly downloads

## Install

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

Provides the commands `dao`, `aragon`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 7.1.6 |
| Published | 2020-06-24 |
| First published | 2017-11-15 |
| Weekly downloads | 0 |
| License | GPL-3.0-or-later |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10.0.0 <11 \|\| >=12.0.0 <13 |
| Dependencies | 40 |
| Unpacked size | 599.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 89 |
| Author | Aragon Association |
| Maintainers | ajsantander, andy-hook, aragon-ci, bingen, bpierre, evalir, facuspagnuolo, gabrielg, izqui, luisivan, sohkai |
| Keywords | cli, aragon, ethereum |

## Links

- npm: https://www.npmjs.com/package/@aragon/cli
- Repository: https://github.com/aragon/aragon-cli/tree/master/packages/aragon-cli
- Homepage: https://github.com/aragon/aragon-cli#readme
- Issues: https://github.com/aragon/aragon-cli/issues
- npm.io page: https://npm.io/package/@aragon/cli

## Dependencies (40)

- [ajv](https://npm.io/package/ajv.md) ^6.6.2
- [ncp](https://npm.io/package/ncp.md) ^2.0.0
- [open](https://npm.io/package/open.md) ^7.0.0
- [web3](https://npm.io/package/web3.md) ^1.2.4
- [bn.js](https://npm.io/package/bn.js.md) ^5.0.0
- [chalk](https://npm.io/package/chalk.md) ^4.0.0
- [execa](https://npm.io/package/execa.md) ^4.0.1
- [listr](https://npm.io/package/listr.md) ^0.14.3
- [which](https://npm.io/package/which.md) ^2.0.1
- [yargs](https://npm.io/package/yargs.md) ^15.3.1
- [ignore](https://npm.io/package/ignore.md) ^5.1.8
- [rimraf](https://npm.io/package/rimraf.md) ^3.0.2
- [semver](https://npm.io/package/semver.md) ^7.3.0
- [figures](https://npm.io/package/figures.md) ^3.0.0
- [find-up](https://npm.io/package/find-up.md) ^4.0.0
- [is-ipfs](https://npm.io/package/is-ipfs.md) ^1.0.3
- [dev-null](https://npm.io/package/dev-null.md) ^0.1.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.0
- [inquirer](https://npm.io/package/inquirer.md) ^7.0.0
- [cli-table](https://npm.io/package/cli-table.md) ^0.3.1
- [git-clone](https://npm.io/package/git-clone.md) ^0.1.0
- [public-ip](https://npm.io/package/public-ip.md) ^4.0.1
- [web3-utils](https://npm.io/package/web3-utils.md) ^1.2.7
- [@aragon/apm](https://npm.io/package/@aragon/apm.md) ^3.1.4
- [http-server](https://npm.io/package/http-server.md) ^0.12.1
- [internal-ip](https://npm.io/package/internal-ip.md) ^6.0.0
- [listr-input](https://npm.io/package/listr-input.md) 0.2.1
- [tmp-promise](https://npm.io/package/tmp-promise.md) ^3.0.2
- [engine-check](https://npm.io/package/engine-check.md) ^1.0.1
- [find-process](https://npm.io/package/find-process.md) ^1.4.2
- [ganache-core](https://npm.io/package/ganache-core.md) ^2.9.0
- [@aragon/connect](https://npm.io/package/@aragon/connect.md) ^0.2.0
- [@aragon/toolkit](https://npm.io/package/@aragon/toolkit.md) ^0.0.5
- [eth-ens-namehash](https://npm.io/package/eth-ens-namehash.md) ^2.0.8
- [truffle-flattener](https://npm.io/package/truffle-flattener.md) ^1.2.9
- [source-map-support](https://npm.io/package/source-map-support.md) ^0.5.11
- [listr-silent-renderer](https://npm.io/package/listr-silent-renderer.md) ^1.1.1
- [listr-update-renderer](https://npm.io/package/listr-update-renderer.md) ^0.5.0
- [listr-verbose-renderer](https://npm.io/package/listr-verbose-renderer.md) ^0.6.0
- [@aragon/truffle-config-v5](https://npm.io/package/@aragon/truffle-config-v5.md) ^1.0.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 7.1.6 (latest) — 2020-06-24
- 1.0.0 — 2023-07-20
- 7.1.5 — 2020-05-19
- 7.1.4 — 2020-05-18
- 7.1.3 — 2020-03-28
- 7.1.2 — 2020-03-21
- 7.1.1 — 2020-02-19
- 7.1.0 — 2020-02-11
- 7.0.4 — 2020-01-07
- 7.0.3 — 2020-01-04
- 7.0.2 — 2019-12-20
- 7.0.1 — 2019-12-19
- 7.0.0 — 2019-12-19
- 7.0.0-beta.13 — 2019-12-17
- 7.0.0-beta.12 — 2019-12-16
- … 123 more at https://npm.io/package/@aragon/cli/versions

## README

![aragonCLI logo](/docs/assets/brand/aragoncli.png)

<div align="center">
  <!-- Downloads -->
  <a href="https://npmjs.org/package/@aragon/cli">
    <img src="https://img.shields.io/npm/dm/@aragon/cli.svg?style=flat-square"
      alt="Downloads" />
  </a>
  <!-- Standard -->
  <a href="https://standardjs.com">
    <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square"
      alt="Standard" />
  </a>
  <!-- Lerna -->
  <a href="https://lerna.js.org/">
    <img src="https://img.shields.io/badge/maintained%20with-lerna-blueviolet.svg?style=flat-square"
      alt="Lerna" />
  </a>
</div>

<div align="center">
  <h4>
    <a href="https://aragon.org">
      Website
    </a>
    <span> | </span>
    <a href="https://hack.aragon.org/docs/cli-intro.html">
      Documentation
    </a>
    <span> | </span>
    <a href="CHANGELOG.md">
      Changelog
    </a>
    <span> | </span>
    <a href="CONTRIBUTING.md">
      Contributing
    </a>
    <span> | </span>
    <a href="https://spectrum.chat/aragon">
      Support &amp; Chat
    </a>
  </h4>
</div>

# aragonCLI

The aragonCLI (Command Line Interface) is used to create and develop Aragon Apps, as well as to
interact with DAOs (create, install apps, inspect permissions, etc.).

## Stable builds 🌳

[![NPM][latest-stable-npm-badge]][npm-link]
[![Docs][latest-stable-docs-badge]][latest-stable-docs-link]
[![API stability][stability-stable-badge]][stability-docs-link]

Periodically, after some testing has been done, we mark `nightly` builds as `stable`.
This build is recommended to most people, especially devs that are getting started and not familiar
with the stack, or anyone who values stability over the bleeding-edge features.

```sh
npm install --global @aragon/cli
```

To install an older version:

```sh
npm install --global @aragon/cli@7.1.3
```

Stable versions:

| Version  | NPM page                              | Docs                                     | Release date |
| -------- | ------------------------------------- | ---------------------------------------- | ------------ |
| `v7.1.3` | [![NPM][713-npm-badge]][713-npm-link] | [![Docs][713-docs-badge]][713-docs-link] | 2020-03-27   |

[latest-stable-npm-badge]: https://img.shields.io/npm/v/@aragon/cli/stable.svg?style=flat-square
[latest-stable-docs-badge]: https://img.shields.io/badge/docs-latest%20stable-blue.svg?style=flat-square
[latest-stable-docs-link]: https://hack.aragon.org/docs/cli-intro.html
[713-npm-badge]: https://img.shields.io/badge/npm-v7.1.3-blue.svg?style=flat-square
[713-npm-link]: https://www.npmjs.com/package/@aragon/cli/v/7.1.3
[713-docs-badge]: https://img.shields.io/badge/docs-v7.1.3-blue.svg?style=flat-square
[713-docs-link]: https://github.com/aragon/aragon-cli/blob/v7.1.3/docs/Intro.md

## Nightly builds 🌒

[![NPM version][nightly-npm-badge]][npm-link]
[![Docs][nightly-docs-badge]][nightly-docs-link]
[![API stability][stability-experimental-badge]][stability-docs-link]
[![Code coverage][nightly-coverage-badge]][nightly-coverage-link]
[![Build status][nightly-build-badge]][nightly-build-link]

Nightly builds may contain features in their early stages, expect things to break!

**Get a sneak peek at the next version of the CLI, and help us making it better in the process!**
**Please try it out and let us know early and often if you find any bugs or regressions. Thanks!**

```sh
npm install --global @aragon/cli@nightly
```

It can also be built and installed from the source code:

```sh
git clone https://github.com/aragon/aragon-cli.git
cd aragon-cli
npm install
npm run build
```

[nightly-npm-badge]: https://img.shields.io/npm/v/@aragon/cli/nightly.svg?style=flat-square&color=blueviolet
[nightly-docs-badge]: https://img.shields.io/badge/docs-master-blue.svg?style=flat-square
[nightly-docs-link]: https://hack.aragon.org/docs/cli-intro.html
[nightly-coverage-badge]: https://img.shields.io/coveralls/aragon/aragon-cli.svg?style=flat-square
[nightly-coverage-link]: https://coveralls.io/github/aragon/aragon-cli
[nightly-build-badge]: https://img.shields.io/travis/aragon/aragon-cli/master.svg?style=flat-square
[nightly-build-link]: https://travis-ci.org/aragon/aragon-cli/branches
[npm-link]: https://npmjs.org/package/@aragon/cli
[stability-stable-badge]: https://img.shields.io/badge/stability-stable-brightgreen.svg?style=flat-square
[stability-experimental-badge]: https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square
[stability-docs-link]: https://nodejs.org/api/documentation.html#documentation_stability_index

## Related packages

| Package             | Version (latest/stable)                               | Version (nightly)                                             | Downloads                                                 |
| ------------------- | ----------------------------------------------------- | ------------------------------------------------------------- | --------------------------------------------------------- |
| `create-aragon-app` | [![NPM version][caa-npm-badge]][caa-npm-link]         | [![NPM version][caa-npm-badge-nightly]][caa-npm-link]         | [![Downloads][caa-downloads-badge]][caa-npm-link]         |
| `toolkit`           | [![NPM version][toolkit-npm-badge]][toolkit-npm-link] | [![NPM version][toolkit-npm-badge-nightly]][toolkit-npm-link] | [![Downloads][toolkit-downloads-badge]][toolkit-npm-link] |

[caa-npm-badge]: https://img.shields.io/npm/v/create-aragon-app/latest.svg?style=flat-square
[caa-npm-link]: https://npmjs.org/package/create-aragon-app
[caa-npm-badge-nightly]: https://img.shields.io/npm/v/create-aragon-app/nightly.svg?style=flat-square&color=blueviolet
[caa-downloads-badge]: https://img.shields.io/npm/dm/create-aragon-app.svg?style=flat-square
[toolkit-npm-badge]: https://img.shields.io/npm/v/@aragon/toolkit/latest.svg?style=flat-square
[toolkit-npm-link]: https://npmjs.org/package/@aragon/toolkit
[toolkit-npm-badge-nightly]: https://img.shields.io/npm/v/@aragon/toolkit/nightly.svg?style=flat-square&color=blueviolet
[toolkit-downloads-badge]: https://img.shields.io/npm/dm/@aragon/toolkit.svg?style=flat-square

## Tests

In the root of the repository, run:

```sh
npm run pretest
```

And then run:

```sh
npm test
```

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