diff --git a/CHANGELOG.md b/CHANGELOG.md index ff585113..dfdd1973 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file automatically by Versionist. DO NOT EDIT THIS FILE MANUALLY! This project adheres to [Semantic Versioning](http://semver.org/). +## v7.0.2 - 2018-03-13 + +* Update full CLI docs with recent installation improvements too #807 [Tim Perry] + ## v7.0.1 - 2018-03-12 * Recommend using unsafe-prem to avoid permission issues on install #805 [Tim Perry] diff --git a/README.md b/README.md index 902703ba..e95287a6 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ or if you have any trouble with this, please try the new standalone install step This might require elevated privileges in some environments. ```sh -$ npm install --global --production resin-cli --unsafe-perm +$ npm install resin-cli -g --production --unsafe-perm ``` `--unsafe-perm` is only required on systems where the global install directory is not user-writable. @@ -62,15 +62,12 @@ To install the CLI as a standalone binary: * Download the latest zip for your OS from https://github.com/resin-io/resin-cli/releases. * Extract the contents, putting the `resin-cli` folder somewhere appropriate for your system (e.g. `C:/resin-cli`, `/usr/local/lib/resin-cli`, etc). -* Add the `resin-cli` folder to your `PATH`. ( -[Windows instructions](https://www.computerhope.com/issues/ch000549.htm), -[Linux instructions](https://stackoverflow.com/questions/14637979/how-to-permanently-set-path-on-linux-unix), -[OSX instructions](https://stackoverflow.com/questions/22465332/setting-path-environment-variable-in-osx-permanently)) +* Add the `resin-cli` folder to your `PATH` ([Windows instructions](https://www.computerhope.com/issues/ch000549.htm), [Linux instructions](https://stackoverflow.com/questions/14637979/how-to-permanently-set-path-on-linux-unix), [OSX instructions](https://stackoverflow.com/questions/22465332/setting-path-environment-variable-in-osx-permanently)) * Running `resin` in a fresh command line should print the resin CLI help. To update in future, simply download a new release and replace the extracted folder. -Have any problems, or see any unexpected behaviour? Please file an issue! +Have any problems, or see any unexpected behaviour? [Please file an issue!](https://github.com/resin-io/resin-cli/issues/new) ### Login diff --git a/capitanodoc.coffee b/capitanodoc.coffee deleted file mode 100644 index fde55050..00000000 --- a/capitanodoc.coffee +++ /dev/null @@ -1,115 +0,0 @@ -# coffeelint: disable=max_line_length - -module.exports = - title: 'Resin CLI Documentation' - introduction: ''' - This tool allows you to interact with the resin.io api from the comfort of your command line. - - Please make sure your system meets the requirements as specified in the [README](https://github.com/resin-io/resin-cli). - - To get started download the CLI from npm. - - $ npm install resin-cli -g - - Then authenticate yourself: - - $ resin login - - Now you have access to all the commands referenced below. - - ## Proxy support - - The CLI does support HTTP(S) proxies. - - You can configure the proxy using several methods (in order of their precedence): - - * set the `RESINRC_PROXY` environment variable in the URL format (with protocol, host, port, and optionally the basic auth), - * use the [resin config file](https://www.npmjs.com/package/resin-settings-client#documentation) (project-specific or user-level) - and set the `proxy` setting. This can be: - * a string in the URL format, - * or an object following [this format](https://www.npmjs.com/package/global-tunnel-ng#options), which allows more control, - * or set the conventional `https_proxy` / `HTTPS_PROXY` / `http_proxy` / `HTTP_PROXY` - environment variable (in the same standard URL format). - ''' - - categories: [ - { - title: 'Application' - files: [ 'lib/actions/app.coffee' ] - }, - { - title: 'Authentication', - files: [ 'lib/actions/auth.coffee' ] - }, - { - title: 'Device', - files: [ 'lib/actions/device.coffee' ] - }, - { - title: 'Environment Variables', - files: [ 'lib/actions/environment-variables.coffee' ] - }, - { - title: 'Help', - files: [ 'lib/actions/help.coffee' ] - }, - { - title: 'Information', - files: [ 'lib/actions/info.coffee' ] - }, - { - title: 'Keys', - files: [ 'lib/actions/keys.coffee' ] - }, - { - title: 'Logs', - files: [ 'lib/actions/logs.coffee' ] - }, - { - title: 'Sync', - files: [ 'lib/actions/sync.coffee' ] - }, - { - title: 'SSH', - files: [ 'lib/actions/ssh.coffee' ] - }, - { - title: 'Notes', - files: [ 'lib/actions/notes.coffee' ] - }, - { - title: 'OS', - files: [ 'lib/actions/os.coffee' ] - }, - { - title: 'Config', - files: [ 'lib/actions/config.coffee' ] - }, - { - title: 'Preload', - files: [ 'lib/actions/preload.coffee' ] - }, - { - title: 'Settings', - files: [ 'lib/actions/settings.coffee' ] - }, - { - title: 'Wizard', - files: [ 'lib/actions/wizard.coffee' ] - }, - { - title: 'Local', - files: [ 'lib/actions/local/index.coffee' ] - }, - { - title: 'Deploy', - files: [ - 'lib/actions/build.coffee' - 'lib/actions/deploy.coffee' - ] - }, - { - title: 'Utilities', - files: [ 'lib/actions/util.coffee' ] - }, - ] diff --git a/capitanodoc.ts b/capitanodoc.ts index 9cda44b9..a7457fc7 100644 --- a/capitanodoc.ts +++ b/capitanodoc.ts @@ -5,15 +5,47 @@ This tool allows you to interact with the resin.io api from the comfort of your Please make sure your system meets the requirements as specified in the [README](https://github.com/resin-io/resin-cli). -To get started download the CLI from npm. +## Install the CLI - $ npm install resin-cli -g +### Npm install -Then authenticate yourself: +The best supported way to install the CLI is from npm: + + $ npm install resin-cli -g --production --unsafe-perm + +\`--unsafe-perm\` is only required on systems where the global install directory is not user-writable. +This allows npm install steps to download and save prebuilt native binaries. You may be able to omit it, +especially if you're using a user-managed node install such as [nvm](https://github.com/creationix/nvm). + +### Standalone install + +Alternatively, if you don't have a node or pre-gyp environment, you can still install the CLI as a standalone +binary. **This is in experimental and may not work perfectly yet in all environments**, but works well in +initial cross-platform testing, so it may be useful, and we'd love your feedback if you hit any issues. + +To install the CLI as a standalone binary: + +* Download the latest zip for your OS from https://github.com/resin-io/resin-cli/releases. +* Extract the contents, putting the \`resin-cli\` folder somewhere appropriate for your system (e.g. \`C:/resin-cli\`, \`/usr/local/lib/resin-cli\`, etc). +* Add the \`resin-cli\` folder to your \`PATH\`. ( +[Windows instructions](https://www.computerhope.com/issues/ch000549.htm), +[Linux instructions](https://stackoverflow.com/questions/14637979/how-to-permanently-set-path-on-linux-unix), +[OSX instructions](https://stackoverflow.com/questions/22465332/setting-path-environment-variable-in-osx-permanently)) +* Running \`resin\` in a fresh command line should print the resin CLI help. + +To update in future, simply download a new release and replace the extracted folder. + +Have any problems, or see any unexpected behaviour? Please file an issue! + +## Getting started + +Once you have the CLI installed, you'll need to log in, so it can access everything in your resin.io account. + +To authenticate yourself, run: $ resin login -Now you have access to all the commands referenced below. +You now have access to all the commands referenced below. ## Proxy support diff --git a/doc/cli.markdown b/doc/cli.markdown index c7e78b0b..4adff476 100644 --- a/doc/cli.markdown +++ b/doc/cli.markdown @@ -4,15 +4,47 @@ This tool allows you to interact with the resin.io api from the comfort of your Please make sure your system meets the requirements as specified in the [README](https://github.com/resin-io/resin-cli). -To get started download the CLI from npm. +## Install the CLI - $ npm install resin-cli -g +### Npm install -Then authenticate yourself: +The best supported way to install the CLI is from npm: + + $ npm install resin-cli -g --production --unsafe-perm + +`--unsafe-perm` is only required on systems where the global install directory is not user-writable. +This allows npm install steps to download and save prebuilt native binaries. You may be able to omit it, +especially if you're using a user-managed node install such as [nvm](https://github.com/creationix/nvm). + +### Standalone install + +Alternatively, if you don't have a node or pre-gyp environment, you can still install the CLI as a standalone +binary. **This is in experimental and may not work perfectly yet in all environments**, but works well in +initial cross-platform testing, so it may be useful, and we'd love your feedback if you hit any issues. + +To install the CLI as a standalone binary: + +* Download the latest zip for your OS from https://github.com/resin-io/resin-cli/releases. +* Extract the contents, putting the `resin-cli` folder somewhere appropriate for your system (e.g. `C:/resin-cli`, `/usr/local/lib/resin-cli`, etc). +* Add the `resin-cli` folder to your `PATH`. ( +[Windows instructions](https://www.computerhope.com/issues/ch000549.htm), +[Linux instructions](https://stackoverflow.com/questions/14637979/how-to-permanently-set-path-on-linux-unix), +[OSX instructions](https://stackoverflow.com/questions/22465332/setting-path-environment-variable-in-osx-permanently)) +* Running `resin` in a fresh command line should print the resin CLI help. + +To update in future, simply download a new release and replace the extracted folder. + +Have any problems, or see any unexpected behaviour? Please file an issue! + +## Getting started + +Once you have the CLI installed, you'll need to log in, so it can access everything in your resin.io account. + +To authenticate yourself, run: $ resin login -Now you have access to all the commands referenced below. +You now have access to all the commands referenced below. ## Proxy support diff --git a/package.json b/package.json index 6ab387c8..eedda1e5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "resin-cli", - "version": "7.0.1", + "version": "7.0.2", "description": "The official resin.io CLI tool", "main": "./build/actions/index.js", "homepage": "https://github.com/resin-io/resin-cli",