codings-dan commented on code in PR #646: URL: https://github.com/apache/ratis/pull/646#discussion_r875423863
########## ratis-docs/content/cli.md: ########## @@ -23,6 +23,37 @@ Ratis-shell is the command line interface of Ratis. > Ratis-shell is currently only **experimental**. > The compatibility story is not considered for the time being. + +## Get the ratis-shell source + +>Mention: Ratis shell is available starting from Apache Ratis 2.3.0. + +### Build `ratis-shell` from src tarball +Get the ratis src tarball from [Ratis Source Download](https://ratis.apache.org/downloads.html) + +``` +$ tar -C <DST_DIR> -zxvf apache-ratis-*-src.tar.gz + +$ cd <DST_DIR>/apache-ratis-*-src + +$ mvn -DskipTests -Prelease -Papache-release clean package assembly:single +... +[INFO] BUILD SUCCESS + +$ tar -C <DST_DIR>/ratis-shell -xzf ratis-assembly/target/apache-ratis-2.3.0-SNAPSHOT-src.tar.gz + +$ cd <DST_DIR>/ratis-shell/apache-ratis-2.3.0-SNAPSHOT +``` +TODO(codings-dan): Get `ratis-shell` from bin tarball directly Review Comment: I have remove this TODO. I will add this part in the future. What can I do to make user get `ratis-shell` from bin tarball directly, I'd love to take this task and complete it! -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
