This is an automated email from the ASF dual-hosted git repository.
ethanfeng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/celeborn.git
The following commit(s) were added to refs/heads/main by this push:
new 12f25d3d0 [CELEBORN-1678] Add Celeborn CLI User guide in README
12f25d3d0 is described below
commit 12f25d3d0fffd815298ec44ebb7cf23c4bc639fd
Author: Aravind Patnam <[email protected]>
AuthorDate: Wed Oct 30 19:58:34 2024 +0800
[CELEBORN-1678] Add Celeborn CLI User guide in README
### What changes were proposed in this pull request?
adding user guide to README for cli
### Why are the changes needed?
better user experience when using CLI.
### Does this PR introduce _any_ user-facing change?
no
### How was this patch tested?
N/A
Closes #2862 from akpatnam25/CELEBORN-1678.
Authored-by: Aravind Patnam <[email protected]>
Signed-off-by: mingji <[email protected]>
---
docs/cli.md | 36 ++++++++++++++++++++++++++++++++++++
mkdocs.yml | 1 +
2 files changed, 37 insertions(+)
diff --git a/docs/cli.md b/docs/cli.md
new file mode 100644
index 000000000..8ef5186d9
--- /dev/null
+++ b/docs/cli.md
@@ -0,0 +1,36 @@
+# Celeborn CLI User Guide
+
+## Build
+- Create the distribution:
+```sh
+./build/make-distribution.sh
+```
+
+- Inside the distribution, there should be a new directory called cli-jars.
This directory contains all the jars necessary for the Celeborn CLI to work.
+ - Please note that Celeborn CLI requires version 0.6+ of Celeborn to work
since it depends on OpenAPI for API calls.
+
+## Setup
+- Set JAVA_HOME if not set already on your machine:
+```sh
+export JAVA_HOME=/path/to/java/home
+```
+- Add the path of the sbin dir to your $PATH:
+```sh
+export
PATH=$PATH:/path/to/CELEBORN_HOME/apache-celeborn-0.6.0-SNAPSHOT-bin/sbin
+```
+- Verify celeborn-cli works:
+```sh
+[~]$ celeborn-cli --version
+Celeborn CLI - Celeborn 0.6.0-SNAPSHOT
+[~]$
+```
+
+## Using Celeborn CLI
+The commands available can be seen via the help command. For example, for
master commands:
+```sh
+celeborn-cli master -h
+```
+Similarily, for worker commands:
+```sh
+celeborn-cli worker -h
+```
diff --git a/mkdocs.yml b/mkdocs.yml
index 92e03dfdd..ffbaa8c9d 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -70,6 +70,7 @@ nav:
- Monitoring:
- Overview: monitoring.md
- Rest API: restapi.md
+ - Celeborn CLI: cli.md
- Security: security.md
- Quota Management: quota_management.md
- Upgrading: upgrading.md
