Skip to content
This repository was archived by the owner on Mar 29, 2022. It is now read-only.

Commit 3dd1924

Browse files
committed
first pass at install cli text
1 parent e8865dc commit 3dd1924

File tree

1 file changed

+76
-1
lines changed

1 file changed

+76
-1
lines changed

docs/install_cli.md

Lines changed: 76 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,76 @@
1-
# Install and Configure the CLI
1+
### Install and Configure the CLI
2+
3+
The primary method for interacting with the SD2E platform is the Agave command
4+
line interface (CLI). The CLI is a collection of ~150 shell scripts for managing
5+
authorization, files, systems, jobs, and more.
6+
7+
There are three methods to install the CLI:
8+
1. Run an installer script to install in ~/sd2e-cloud-cli/bin/
9+
2. Manual install to a location of your choosing
10+
3. Pull a CLI Docker image
11+
12+
#### 1. Run an installer script to install in ~/sd2e-cloud-cli/bin/
13+
14+
Open a terminal window and perform the following:
15+
16+
```
17+
# Run the installer
18+
% curl -L https://raw.githubusercontent.com/sd2e/sd2e-cli/master/install/install.sh | sh
19+
20+
# Source your .bashrc
21+
% source ~/.bashrc
22+
23+
# Verify the CLI is installed
24+
% sd2e info
25+
26+
DARPA SD2E version 1.0.1
27+
TACC Cloud API tenant: sd2e
28+
TACC Cloud API versions:
29+
Science APIs: 2.2.5
30+
Reactors API: dev
31+
TACC Accounting API: v1
32+
```
33+
34+
#### 2. Manual install to a location of your choosing
35+
36+
Open a terminal window and perform the following:
37+
38+
```
39+
# Navigate to a location of your choosing
40+
% mkdir sd2e-project && cd sd2e-project
41+
42+
# Download and unpack the CLI
43+
% curl -L https://raw.githubusercontent.com/sd2e/sd2e-cli/master/sd2e-cloud-cli.tgz -o sd2e-cloud-cli.tgz
44+
% tar -xvzf sd2e-cloud-cli.tgz
45+
46+
# Add the CLI executables to your $PATH
47+
% echo "PATH=\$PATH:$PWD/sd2e-cloud-cli/bin" >> ~/.bashrc
48+
% source ~/.bashrc
49+
50+
# Verify the CLI is installed
51+
% sd2e info
52+
53+
DARPA SD2E version 1.0.1
54+
TACC Cloud API tenant: sd2e
55+
TACC Cloud API versions:
56+
Science APIs: 2.2.5
57+
Reactors API: dev
58+
```
59+
60+
#### 3. Pull a CLI Docker image
61+
62+
```
63+
# Pull the latest image
64+
% docker pull sd2e/cloud-cli:latest
65+
% docker run -it -v $HOME/.agave:/root/.agave sd2e/cloud-cli bash
66+
```
67+
68+
#### Influential environment variables
69+
70+
AGAVE_TENANT
71+
AGAVE_USERNAME
72+
AGAVE_KEY
73+
AGAVE_JSON_PARSER = json_mirror | jq | json | python | native
74+
AGAVE_DISABLE_AUTO_REFRESH
75+
76+

0 commit comments

Comments
 (0)