|
3 | 3 | [](https://github.com/project-codeflare/codeflare-cli/actions/workflows/kind.yml)
|
4 | 4 | [](https://github.com/project-codeflare/codeflare-cli/actions/workflows/self-test.yml)
|
5 | 5 |
|
6 |
| -# CodeFlare Desktop Client |
| 6 | +# The CodeFlare CLI |
7 | 7 |
|
8 | 8 | <p align="center">
|
9 |
| -<img src="./images/codeflare_cli.svg" width="110" height="110" align="left"> |
| 9 | + <img src="./images/codeflare_cli.svg" width="110" height="110" align="left"> |
10 | 10 | </p>
|
11 | 11 |
|
| 12 | +<a href="https://asciinema.org/a/518021" target="_blank"><img src="https://asciinema.org/a/518021.svg" width="300" align="right"/></a> |
| 13 | + |
12 | 14 | [CodeFlare](https://codeflare.dev) is a framework to simplify the
|
13 | 15 | integration, scaling and acceleration of complex multi-step analytics
|
14 | 16 | and machine learning pipelines on the cloud.
|
15 | 17 |
|
16 | 18 | This repository is home to the open source CodeFlare CLI,
|
17 |
| -`codeflare`. On macOS, you can [get started |
18 |
| -immediately](#installation) using `brew install`. |
19 |
| - |
20 |
| -| **Rapid Job Submission** | **Optimized Inner Loop** | **Pop-up Dashboards** | |
21 |
| -| ----------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | |
22 |
| -| `codeflare` guides you via a series of questions. Where is your data? How many GPUs are needed? | You may name the set of answers you provided. We call this a **profile**. Your inner loop becomes: `codeflare -y -p <profileName>` | `codeflare` offers convenient access to MLFlow, Tensorboard, and a custom dashboard that tracks a job's resources and logs. | |
23 |
| -| `codeflare` glues answers together and submits a Kubernetes job. | Quickly switch between profiles. Submit concurrent jobs to distinct profiles. | No fiddling with yaml and port forwards. With a few clicks, a dashboard window pops open. | |
24 |
| - |
25 |
| -## Scenarios |
26 |
| - |
27 |
| -Interested in finding use cases that match up with your own? Check out our [Scenarios](./docs/scenarios/#readme) page. |
| 19 | +`codeflare`. This CLI helps you to submit and observe jobs in a |
| 20 | +Kubernetes cluster. |
28 | 21 |
|
29 |
| -## Tray Menu |
| 22 | +[Check out some use cases in motion](./docs/scenarios/README.md#readme). |
30 | 23 |
|
31 |
| -<img align="right" width="275" src="docs/images/tray/activeruns.png"> |
32 |
| - |
33 |
| -The CodeFlare tray menu offers quick access to the most common |
34 |
| -features. On macOS and Linux, the menu will appear the upper right of |
35 |
| -your menubar, as shown in the screenshot to the right. |
36 |
| - |
37 |
| -To launch the CodeFlare tray menu from your terminal, try `codeflare hello`. You should now see a `CF` tray menu. |
| 24 | +<a href="https://asciinema.org/a/517993" target="_blank"><img src="https://asciinema.org/a/517993.svg" width="300" align="right"/></a> |
38 | 25 |
|
39 | 26 | ## Installation
|
40 | 27 |
|
41 |
| -On macOS, if you have [HomeBrew](https://brew.sh/) installed: |
| 28 | +Please visit the |
| 29 | +[Releases](https://github.com/project-codeflare/codeflare-cli/releases/latest) |
| 30 | +page to download the package for your platform, unpack it, and place |
| 31 | +the enclosed `bin/` directory on your `PATH`. macOS users may use |
| 32 | +[HomeBrew](https://brew.sh/) to expedite installation: |
42 | 33 |
|
43 | 34 | brew tap project-codeflare/codeflare-cli https://github.com/project-codeflare/codeflare-cli
|
44 | 35 | brew install codeflare
|
45 | 36 |
|
46 |
| -Otherwise, visit our |
47 |
| -[Releases](https://github.com/project-codeflare/codeflare-cli/releases/latest) |
48 |
| -page to download the zip file for your platform. Unzip and place the |
49 |
| -enclosed `bin/` directory on your `PATH`. |
| 37 | +<a href="https://asciinema.org/a/517989" target="_blank"><img src="https://asciinema.org/a/517989.svg" width="300" align="right"/></a> |
50 | 38 |
|
51 | 39 | ## Command Line Options
|
52 | 40 |
|
53 | 41 | - `-y/--yes`: Repeat a prior run using all of the same answers, without any prompts.
|
54 | 42 | - `-p/--profile`: Use a named profile. By default, your choices will be stored in a profile named "default".
|
55 |
| -- `-t/--team`: We have support for specializing the CLI towards specific clusters. Contact your admin for a preferred team name. |
56 | 43 | - `-V`: this will provide verbose output of the tool's operation.
|
57 | 44 |
|
58 | 45 | ## Contributing
|
|
0 commit comments