From f65da9febf4eba7fce7d401d784bbcde5c0ce03f Mon Sep 17 00:00:00 2001 From: Jane Wang Date: Wed, 28 Feb 2024 11:17:38 -0400 Subject: [PATCH] Update cli readme --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0d052ba367..22d2a2e689 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,30 @@ -# soroban-tools +# Soroban CLI (soroban-cli) This repo is home to the [Soroban CLI](https://github.com/stellar/soroban-tools/tree/main/cmd/soroban-cli): The command-line multi-tool for running and deploying Soroban contracts. + +## Setup Autocomplete +`soroban completion --shell ` +Possible SHELL values are `bash`, `elvish`, `fish`, `powershell`, `zsh`, etc. + +To enable autocomplete in the current bash shell, run: +`source <(soroban completion --shell bash)` + +To enable autocomplete permanently, run: +`echo "source <(soroban completion --shell bash)" >> ~/.bashrc` + +## Full Docs + +For autogenerated full docs, please see +[docs](/blob/main/docs/soroban-cli-full-docs.md). + +## Latest Release +For latest releases, please see +[releases](/releases). + Soroban: https://soroban.stellar.org -# Adding git hooks +## Adding git hooks To add git hooks for commits and pushes run: @@ -12,4 +32,4 @@ To add git hooks for commits and pushes run: ./install_githooks.sh ``` -which copies the git hooks found at `.cargo-husky/hooks` to `.git/hooks`. \ No newline at end of file +which copies the git hooks found at `.cargo-husky/hooks` to `.git/hooks`.