Skip to content

Commit d44406e

Browse files
committed
doc: add screenshots
1 parent c86cfa5 commit d44406e

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,15 @@ immediately](#installation) using `brew install`.
2222
| `codeflare` guides you via a series of questions. Where is your code? Where is your data? How many GPUs do you need? | You may name the set of answers you provided. We call this a **profile**. Your inner loop then becomes: `codeflare -y -p <profileName>`. The `-y` means accept all prior answers. | `codeflare` offers quick access to MLFlow, Tensorboard, and a custom dashboard that tracks the resource consumption and logs of a job. |
2323
| `codeflare` glues answers together and submits a Kubernetes job. | You can switch quickly between profiles, and even submit jobs to distinct profiles concurrently. | There is no need to fiddle with yaml files and port forwards. With a few clicks, you will get a popup dashboard window. |
2424

25+
## macOS Tray Menu
26+
27+
<img align="right" width="275" src="docs/images/tray/activeruns.png">
28+
29+
If you are on macOS, you can leverage the menu that `codeflare` places
30+
in the upper right of your menubar (commonly known as a "tray"
31+
menu). From your terminal, try `codeflare hello`, and you should see a
32+
`CF` tray menu.
33+
2534
## Installation
2635

2736
On macOS, if you have [HomeBrew](https://brew.sh/) installed:
@@ -34,7 +43,12 @@ Otherwise, visit our
3443
page to download the zip file for your platform. Unzip and place the
3544
enclosed `bin/` directory on your `PATH`.
3645

37-
</details>
46+
## Command Line Options
47+
48+
- `-y/--yes`: Repeat a prior run using all of the same answers, without any prompts.
49+
- `-p/--profile`: Use a named profile. By default, your choices will be stored in a profile named "default".
50+
- `-t/--team`: We have support for specializing the CLI towards specific clusters. Contact your admin for a preferred team name.
51+
- `-V`: this will provide verbose output of the tool's operation.
3852

3953
## Contributing
4054

docs/images/tray/activeruns.png

101 KB
Loading

0 commit comments

Comments
 (0)