-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Jane Wang
authored and
Jane Wang
committed
Feb 28, 2024
1 parent
31407a4
commit f65da9f
Showing
1 changed file
with
23 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,35 @@ | ||
# 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 <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: | ||
|
||
``` | ||
./install_githooks.sh | ||
``` | ||
|
||
which copies the git hooks found at `.cargo-husky/hooks` to `.git/hooks`. | ||
which copies the git hooks found at `.cargo-husky/hooks` to `.git/hooks`. |