Skip to content

Commit

Permalink
Merge pull request #147 from CircleCI-Public/circle-13971-install-info
Browse files Browse the repository at this point in the history
[CIRCLE-13971] Adding installation info to readme
  • Loading branch information
Zachary Scott authored Oct 5, 2018
2 parents 774639b + f0dfdd7 commit a631498
Showing 1 changed file with 30 additions and 8 deletions.
38 changes: 30 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,32 @@ This project is the seed for CircleCI's new command-line application.

## Getting Started

### From Scratch

#### Install script

If you're installing the new `circleci` CLI for the first time, run the following command:

```
bash -c "$(curl -fSl https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/master/install.sh)"
```

This will install the CLI into the `/usr/local/bin` directory.

If you do not have write permissions to `/usr/local/bin`, you may need to run the above command with `sudo`.

#### Homebrew

```
brew install circleci
```

#### Snapcraft

```
sudo snap install circleci
```

### Upgrade from existing CLI

If you installed the old CLI before, and you're on version less than `0.1.6`, you need to run the following commands:
Expand All @@ -26,18 +52,14 @@ circleci switch

This command may prompt you for `sudo` if your user doesn't have write permissions to the install directory, `/usr/local/bin`.

### From Scratch

If you're installing the new `circleci` CLI for the first time, run the following command:
### Updating after install

The CLI comes with a built in version managment system. You can check if there any updates pending and update if so using the following commands:
```
bash -c "$(curl -fSl https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/master/install.sh)"
circleci update check
circleci update install
```

This will install the CLI into the `/usr/local/bin` directory.

If you do not have write permissions to `/usr/local/bin`, you may need to run the above command with `sudo`.

## Configure the CLI

You may first need to generate a CircleCI API Token from the [Personal API Token tab](https://circleci.com/account/api).
Expand Down

0 comments on commit a631498

Please sign in to comment.