Metadata-Version: 2.1
Name: cairo-nile
Version: 0.0.3
Summary: StarkNet/Cairo development toolbelt
Home-page: https://github.com/martriay/nile
Author: Martin Triay
Author-email: martriay@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.8
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: click (==8.0.1)

# ⛵ Nile

_Navigate your [StarkNet](https://www.cairo-lang.org/docs/hello_starknet/index.html) projects written in [Cairo](cairo-lang.org)._

## Insatallation

```sh
pip install cairo-nile
```

## Usage

### Install Cairo

Use `nile` to install a given version of the Cairo language. Given Cairo's fast development pace, this command is useful to install the latest version.

```sh
nile install 0.4.0
```

### Compile

Compile Cairo contracts. Compilation articacts are written into the `artifacts/` directory.

```sh
nile compile # compiles all contracts under contracts/
nile compile contracts/MyContract.cairo # compiles single contract
```
Example output:
```
$ nile compile
Creating artifacts/abis/ to store compilation artifacts
🤖 Compiling all Cairo contracts in the contracts/ directory
🔨 Compiling contracts/Account.cairo
🔨 Compiling contracts/Initializable.cairo
🔨 Compiling contracts/Ownable.cairo
✅ Done
```

### Clean

Deletes the `artifacts/` directory for a fresh start ❄️

```
nile clean
```

## License
Nile is released under the MIT License.


