Skip to content

Commit b4a97ca

Browse files
committed
add dev quickstart to readme
1 parent fcbcda0 commit b4a97ca

1 file changed

Lines changed: 55 additions & 13 deletions

File tree

README.md

Lines changed: 55 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@ Compute Manager for managing HPC compute
1111
### Linux
1212

1313
```shell
14-
$ curl -LO https://github.com/SwissDataScienceCenter/coman/releases/latest/download/coman-Linux-x86_64-musl.tar.gz
15-
# tar -xzf coman-Linux-x86_64-musl.tar.gz -C /usr/local/bin/
16-
# chmod +x /usr/local/bin/coman
14+
curl -LO https://github.com/SwissDataScienceCenter/coman/releases/latest/download/coman-Linux-x86_64-musl.tar.gz
15+
sudo tar -xzf coman-Linux-x86_64-musl.tar.gz -C /usr/local/bin/
16+
sudo chmod +x /usr/local/bin/coman
1717
```
1818

1919
### Macos
2020

2121
```shell
22-
$ curl -LO https://github.com/SwissDataScienceCenter/coman/releases/latest/download/coman-Darwin-x86_64.tar.gz
23-
# tar -xzf coman-Darwin-x86_64.tar.gz -C /usr/local/bin/
24-
# chmod +x /usr/local/bin/coman
22+
curl -LO https://github.com/SwissDataScienceCenter/coman/releases/latest/download/coman-Darwin-x86_64.tar.gz
23+
sudo tar -xzf coman-Darwin-x86_64.tar.gz -C /usr/local/bin/
24+
sudo chmod +x /usr/local/bin/coman
2525
```
2626

2727
### Windows
@@ -86,15 +86,15 @@ step unless your keys change.
8686
To create a Coman config for a project/folder, run
8787

8888
```shell
89-
$ coman init <folder>
89+
coman init <folder>
9090
```
9191

9292
This creates a `coman.toml` file that you can customize with settings if you wish.
9393

9494
Select what system you want to run on
9595

9696
```shell
97-
$ coman cscs system ls # this lists systems you can see.
97+
coman cscs system ls # this lists systems you can see.
9898
┌───────┬────────────────────────────┐
9999
│ name │ services_health │
100100
├───────┼────────────────────────────┤
@@ -130,21 +130,25 @@ $ coman cscs system ls # this lists systems you can see.
130130
│ │ ║ Filesystem ║ true ║ │
131131
│ │ ╚══════════════╩═════════╝ │
132132
└───────┴────────────────────────────┘
133-
$ coman cscs system set daint
133+
```
134+
135+
Then set the system (e.g. `daint`) with
136+
```
137+
coman cscs system set daint
134138
```
135139

136140
To execute a job on CSCS, run a command like
137141

138142
```shell
139-
$ coman cscs job submit -i ubuntu:latest -- echo test
143+
coman cscs job submit -i ubuntu:latest -- echo test
140144
```
141145
This will run the command `echo test` using the `ubuntu:latest` docker image and default settings.
142146
See `coman cscs job submit -h` for more options.
143147

144148
You can list your jobs using
145149

146150
```shell
147-
$ coman cscs job list
151+
coman cscs job list
148152
┌─────────┬────────────────┬──────────┬──────────┬────────────────────────────┬────────────────────────────┐
149153
│ id │ name │ status │ user │ start_date │ end_date │
150154
├─────────┼────────────────┼──────────┼──────────┼────────────────────────────┼────────────────────────────┤
@@ -154,7 +158,7 @@ $ coman cscs job list
154158

155159
Get details for a job with
156160
```shell
157-
$ coman cscs job get <id>
161+
coman cscs job get <id>
158162
┌───────────────┬────────────────────────────────────────────────────────┐
159163
│ Id │ 2127021 │
160164
├───────────────┼────────────────────────────────────────────────────────┤
@@ -181,7 +185,7 @@ $ coman cscs job get <id>
181185
Get the logs from a job
182186

183187
```shell
184-
$ coman cscs job log <id>
188+
coman cscs job log <id>
185189
```
186190

187191

@@ -194,3 +198,41 @@ To run the TUI, simply run `coman` without any arguments:
194198
The TUI should be pretty self-explanatory. It gives an overview of your jobs on the selected system,
195199
refreshed every couple of seconds, lets you see the logs and all the other functionality of the CLI,
196200
just in an interactive way.
201+
202+
203+
204+
## Development
205+
206+
### Prerequisites
207+
208+
Make sure you have:
209+
210+
- Rust and Cargo installed (get from https://rustup.rs/)
211+
- OpenSSL development headers
212+
- oas3-gen (install with `cargo install oas3-gen@0.21.1`)
213+
214+
215+
```
216+
cargo build
217+
cargo run
218+
```
219+
220+
221+
### Install binaries
222+
223+
Build the binaries and
224+
```
225+
cargo build --release
226+
```
227+
228+
Then copy it to the bin folder
229+
```
230+
sudo cp target/release/coman /usr/local/bin/
231+
sudo chmod +x /usr/local/bin/coman
232+
```
233+
234+
If you want to use cargo to install `coman`, make sure to remove any version of coman from `/usr/local/bin/` and run
235+
236+
```
237+
cargo install --path ./coman
238+
```

0 commit comments

Comments
 (0)