Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/aragon/aragon-cli

CLI for creating and publishing Aragon apps
https://github.com/aragon/aragon-cli

aragon cli developer-tools ethereum tools

Last synced: 3 months ago
JSON representation

CLI for creating and publishing Aragon apps

Lists

README

        




Downloads



Standard



Lerna




Website

|

Documentation

|

Changelog

|

Contributing

|

Support & Chat


# 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/[email protected]
```

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
```