Skip to content

Commit

Permalink
docs: direct users to the book in README
Browse files Browse the repository at this point in the history
  • Loading branch information
xJonathanLEI committed Jul 16, 2023
1 parent 62ed093 commit 78641fd
Showing 1 changed file with 3 additions and 57 deletions.
60 changes: 3 additions & 57 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@

## Installation

### Linux/macOS/WSL

If you're on a supported platform, the easiest way to install and update `starkli` is to use `starkliup`, which can be installed by running:

```console
Expand All @@ -22,63 +20,11 @@ starkliup

Behind the scene, `starkliup` downloads prebuilt binaries (built from GitHub Actions) so you don't need a Rust installation to use it.

### Windows

If you're on Windows, it's recommended that you use `starkli` under WSL, and thus follow the _Linux/macOS/WSL_ instructions above for installation.

However, it's also possible to use `starkli` natively on Windows. `starkliup` does not support Windows at the moment, but prebuilt binaries are still available for download from [GitHub releases](https://github.com/xJonathanLEI/starkli/releases).

### Cargo

If you have Rust installed, it's also possible to directly install from source:

```console
cargo install --locked starkli
```

## Commands
Check out the [Starkli book](https://book.starkli.rs/installation) for more installation options.

Check the list of available commands by simply running `starkli` without arguments:

```console
$ starkli
Starkli (/ˈstɑːrklaɪ/), a blazing fast CLI tool for Starknet powered by starknet-rs
## Documentation

Usage: starkli <COMMAND>

Commands:
selector Calculate selector from name
class-hash Calculate class hash from any contract artifacts (Sierra, casm, legacy)
to-cairo-string Encode string into felt with the Cairo short string representation
parse-cairo-string Decode string from felt with the Cairo short string representation
mont Print the montgomery representation of a field element
call Call contract functions without sending transactions
transaction Get Starknet transaction by hash
block-number Get latest block number
block-hash Get latest block hash
block Get Starknet block
block-time Get Starknet block timestamp only
state-update Get state update from a certain block
transaction-receipt Get transaction receipt by hash
chain-id Get Starknet network ID
nonce Get nonce for a certain contract
storage Get storage value for a slot at a contract
class-hash-at Get contract class hash deployed at a certain address
class-by-hash Get contract class by hash
class-at Get contract class deployed at a certain address
syncing Get node syncing status
signer Signer management commands
account Account management commands
invoke Send an invoke transaction from an account contract
declare Declare a contract class
deploy Deploy contract via the Universal Deployer Contract
completions Generate shell completions script
help Print this message or the help of the given subcommand(s)

Options:
-h, --help Print help
-V, --version Print version
```
Documentation is available as the [Starkli book](https://book.starkli.rs/).

## License

Expand Down

0 comments on commit 78641fd

Please sign in to comment.