Skip to content

Commit 740b72f

Browse files
committed
Merge pull request #1672 from mboersma/update-cli-links
docs(client): update with dev CLI binaries and local deis.py suggestion
2 parents 21ddb96 + b6ccd8b commit 740b72f

5 files changed

Lines changed: 45 additions & 41 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ If you're using the latest Deis release, use `pip install --upgrade deis` to ins
9595
If you're working off master, precompiled binaries are likely out of date. You should either symlink the python file directly or build a local copy of the client:
9696

9797
```console
98-
$ ln -fs $(pwd)/client/deis.py /usr/local/bin/deis
98+
$ sudo ln -fs $(pwd)/client/deis.py /usr/local/bin/deis
9999
```
100100
or
101101
```console

client/README.rst

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,16 +71,25 @@ Get Started
7171

7272
1. `Install the Client`_:
7373

74+
Your Deis client should match your server's version. For development, an
75+
easy way to ensure this is to run `client/deis.py` in the code repository
76+
you used to provision the server. You can make a symlink or shell alias for
77+
`deis` to that file:
78+
7479
.. code-block:: console
7580
76-
$ sudo pip install deis
81+
$ pip install docopt==0.6.2 python-dateutil==2.2 PyYAML==3.11 requests==2.3.0
82+
$ sudo ln -fs $(pwd)/client/deis.py /usr/local/bin/deis
83+
$ deis
84+
Usage: deis <command> [<args>...]
85+
86+
If you don't have Python_ installed, you can download a binary executable
87+
version of the Deis client for Mac OS X, Linux amd64, or Windows:
7788

78-
If you don't have `Python`_ installed, you can download a binary executable
79-
version of the Deis client for Mac OS X, Windows, or Linux amd64:
89+
- https://s3-us-west-2.amazonaws.com/opdemand/deis-osx-dev.tgz
90+
- https://s3-us-west-2.amazonaws.com/opdemand/deis-ubuntu-dev.tgz
91+
- https://s3-us-west-2.amazonaws.com/opdemand/deis-win64-dev.zip
8092

81-
- https://s3-us-west-2.amazonaws.com/opdemand/deis-osx-0.11.0.tgz
82-
- https://s3-us-west-2.amazonaws.com/opdemand/deis-win64-0.11.0.zip
83-
- https://s3-us-west-2.amazonaws.com/opdemand/deis-ubuntu-0.11.0.tgz
8493

8594
2. `Register a User`_:
8695

docs/contributing/localdev.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ your local workstation.
134134
135135
$ cd $DEIS_DIR/client
136136
$ make install
137-
$ ln -fs $DEIS_DIR/client/deis.py /usr/local/bin/deis
137+
$ sudo ln -fs $DEIS_DIR/client/deis.py /usr/local/bin/deis
138138
$ deis
139139
Usage: deis <command> [<args>...]
140140

docs/installing_deis/register-admin-user.rst

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,25 @@ the client to use Deis.
1212

1313
Install the Deis Client
1414
-----------------------
15-
Install the latest Deis client using Python's pip_ package manager:
15+
Your Deis client should match your server's version. For development, an
16+
easy way to ensure this is to run `client/deis.py` in the code repository
17+
you used to provision the server. You can make a symlink or shell alias for
18+
`deis` to that file:
1619

1720
.. code-block:: console
1821
19-
$ pip install --upgrade deis
20-
Downloading/unpacking deis
21-
Downloading deis-0.11.0.tar.gz
22-
Running setup.py egg_info for package deis
23-
...
24-
Successfully installed deis
25-
Cleaning up...
22+
$ pip install docopt==0.6.2 python-dateutil==2.2 PyYAML==3.11 requests==2.3.0
23+
$ sudo ln -fs $(pwd)/client/deis.py /usr/local/bin/deis
2624
$ deis
2725
Usage: deis <command> [<args>...]
2826
2927
If you don't have Python_ installed, you can download a binary executable
30-
version of the Deis client for Mac OS X, Windows, or Linux amd64:
28+
version of the Deis client for Mac OS X, Linux amd64, or Windows:
29+
30+
- https://s3-us-west-2.amazonaws.com/opdemand/deis-osx-dev.tgz
31+
- https://s3-us-west-2.amazonaws.com/opdemand/deis-ubuntu-dev.tgz
32+
- https://s3-us-west-2.amazonaws.com/opdemand/deis-win64-dev.zip
3133

32-
- https://s3-us-west-2.amazonaws.com/opdemand/deis-osx-0.11.0.tgz
33-
- https://s3-us-west-2.amazonaws.com/opdemand/deis-win64-0.11.0.zip
34-
- https://s3-us-west-2.amazonaws.com/opdemand/deis-ubuntu-0.11.0.tgz
3534

3635
Register a User
3736
---------------

docs/using_deis/install-client.rst

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,29 @@ Install the Client
88
The Deis command-line interface (CLI), or client, allows you to interact
99
with a Deis :ref:`Controller`. You must install the client to use Deis.
1010

11-
Download Binaries
12-
-----------------
13-
You can download a binary executable version of the Deis client for Mac OS X, Windows, or Linux amd64:
14-
15-
- https://s3-us-west-2.amazonaws.com/opdemand/deis-osx-0.11.0.tgz
16-
- https://s3-us-west-2.amazonaws.com/opdemand/deis-win64-0.11.0.zip
17-
- https://s3-us-west-2.amazonaws.com/opdemand/deis-ubuntu-0.11.0.tgz
18-
19-
Extract the ``deis`` binary and place it in your workstation path.
20-
21-
Install with Pip
22-
----------------
23-
You can also install the latest Deis client using Python's pip_ package manager:
11+
Install the Deis Client
12+
-----------------------
13+
Your Deis client should match your server's version. For development, an
14+
easy way to ensure this is to run `client/deis.py` in the code repository
15+
you used to provision the server. You can make a symlink or shell alias for
16+
`deis` to that file:
2417

2518
.. code-block:: console
2619
27-
$ sudo pip install --upgrade deis
28-
Downloading/unpacking deis
29-
Downloading deis-0.11.0.tar.gz
30-
Running setup.py egg_info for package deis
31-
...
32-
Successfully installed deis
33-
Cleaning up...
34-
20+
$ pip install docopt==0.6.2 python-dateutil==2.2 PyYAML==3.11 requests==2.3.0
21+
$ sudo ln -fs $(pwd)/client/deis.py /usr/local/bin/deis
3522
$ deis
3623
Usage: deis <command> [<args>...]
3724
25+
If you don't have Python_ installed, you can download a binary executable
26+
version of the Deis client for Mac OS X, Linux amd64, or Windows:
27+
28+
- https://s3-us-west-2.amazonaws.com/opdemand/deis-osx-dev.tgz
29+
- https://s3-us-west-2.amazonaws.com/opdemand/deis-ubuntu-dev.tgz
30+
- https://s3-us-west-2.amazonaws.com/opdemand/deis-win64-dev.zip
31+
32+
Extract the ``deis`` binary and place it in your workstation path.
33+
3834
Proxy Support
3935
-------------
4036
Set the ```http_proxy``` or ```https_proxy``` environment variable to enable proxy support:

0 commit comments

Comments
 (0)