starkli 0.1.5

Starkli (/ˈstɑːrklaɪ/), a blazing fast CLI tool for Starknet powered by starknet-rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

<p align="center">
  <h1 align="center">starkli</h1>
</p>

**Starkli (/ˈstɑːrklaɪ/), a :zap: blazing :zap: fast :zap: CLI tool for Starknet powered by :crab: [starknet-rs](https://github.com/xJonathanLEI/starknet-rs) :crab:**

## 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
curl https://get.starkli.sh | sh
```

Once `starkliup` is installed, you can then install or update `starkli` simply by running the `starkliup` command without arguments:

```console
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 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

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
```

## License

Licensed under either of

- Apache License, Version 2.0 ([LICENSE-APACHE](./LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT license ([LICENSE-MIT](./LICENSE-MIT) or <http://opensource.org/licenses/MIT>)

at your option.