diff --git a/README.md b/README.md index 671cc0182..73f386b2e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Aragon CLI -CLI tool for creating, testing and publishing Aragon modules. +CLI tool for creating, testing and publishing Aragon applications. ## Installation @@ -11,40 +11,35 @@ npm install -g @aragon/cli ## Usage ``` -➜ aragon-example-module aragon-dev-cli --help - - Aragon command-line tools +➜ aragon-example-application aragon-dev-cli --help Usage $ aragon-dev-cli Commands - init Initialize a new Aragon module - version Bump the module version - versions List the published versions of this module - publish Publish a new version of the module - playground Inject module into local Aragon application + init Initialize a new Aragon application (e.g. test.aragonpm.eth) + version Bump the application version + versions List the published versions of this application + publish Publish a new version of the application + playground Inject application into local Aragon client Options --key The Ethereum private key to sign transactions with. Raw transaction will be dumped to stdout if no key is provided. - --registry The repository registry to use for creating and publishing packages (default: aragonpm.eth) --rpc A URI to the Ethereum node used for RPC calls (default: https://ropsten.infura.io) --chain-id The ID of the chain to interact with (default: 3) + --ens-registry Address for the ENS registry (default: canonical ENS for chainId) Examples $ aragon-dev-cli version major New version is 2.0.0 - $ aragon-dev-cli init poll --registry=module-corp.eth - Created new module poll.module-corp.eth - - $ aragon-dev-cli init cool-app - Created new module cool-app.aragonpm.eth + $ aragon-dev-cli init cool-app.aragonpm.eth + Created new application cool-app.aragonpm.eth ``` ## Recipes -### Creating and publishing a module +### Creating and publishing an application ```bash mkdir polls-app diff --git a/bin/cli.js b/bin/cli.js index cef9b66bf..ec97ccaa9 100755 --- a/bin/cli.js +++ b/bin/cli.js @@ -8,10 +8,10 @@ const cli = meow(` Commands init [template] Initialize a new Aragon module from a template (default template: react). The name must be a valid ENS name. - version Bump the module version - versions List the published versions of this module - publish Publish a new version of the module - playground Inject module into local Aragon application + version Bump the application version + versions List the published versions of this application + publish Publish a new version of the application + playground Inject application into local Aragon client Options --key The Ethereum private key to sign transactions with. Raw transaction will be dumped to stdout if no key is provided. @@ -24,7 +24,7 @@ const cli = meow(` New version is 2.0.0 $ aragon-dev-cli init cool-app.aragonpm.eth - Created new module cool-app.aragonpm.eth + Created new application cool-app.aragonpm.eth `, { default: { rpc: 'https://ropsten.infura.io', diff --git a/src/handle.js b/src/handle.js index 07520c84a..1d5bb9033 100644 --- a/src/handle.js +++ b/src/handle.js @@ -45,7 +45,7 @@ const handlers = { const basename = name.split('.')[0] reporter.info(`Cloning ${template} into ${basename}...`) clone(`https://github.com/${template}`, basename, { shallow: true }, () => { - reporter.info(`Created new module ${name} in ${basename}`) + reporter.info(`Created new application ${name} in ${basename}`) }) }, versions (_, flags) { @@ -198,7 +198,7 @@ const handlers = { )).pop().hash // Next! - reporter.info(`Published module to IPFS: ${hash}`) + reporter.info(`Published application to IPFS: ${hash}`) resolve(hash) }) }) @@ -221,7 +221,7 @@ const handlers = { return } - reporter.info('This is the first time you are publishing this module') + reporter.info('This is the first time you are publishing this application') const registry = new eth.Contract( require('../abi/apm/RepoRegistry.json'), registryAddress @@ -254,7 +254,7 @@ const handlers = { .then((tx) => { return eth.sendSignedTransaction(tx.rawTransaction) .then(({ transactionHash }) => { - reporter.info(`Created module ${appName}@${version} in transaction ${transactionHash}`) + reporter.info(`Created application ${appName}@${version} in transaction ${transactionHash}`) }, (err) => { reporter.error(err) })