{"id":13746321,"url":"https://github.com/OpenZeppelin/nile","last_synced_at":"2025-05-09T07:30:29.866Z","repository":{"id":37713477,"uuid":"408247158","full_name":"OpenZeppelin/nile","owner":"OpenZeppelin","description":"CLI tool to develop StarkNet projects written in Cairo","archived":true,"fork":false,"pushed_at":"2023-12-01T15:24:28.000Z","size":1043,"stargazers_count":322,"open_issues_count":60,"forks_count":76,"subscribers_count":10,"default_branch":"main","last_synced_at":"2024-11-15T19:37:22.106Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpenZeppelin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-19T22:05:19.000Z","updated_at":"2024-10-27T19:49:49.000Z","dependencies_parsed_at":"2023-12-01T16:43:30.049Z","dependency_job_id":null,"html_url":"https://github.com/OpenZeppelin/nile","commit_stats":{"total_commits":195,"total_committers":25,"mean_commits":7.8,"dds":0.5846153846153845,"last_synced_commit":"2eaf0ea3ad65dd6922d174c57adf5dfbd7bbfa97"},"previous_names":["martriay/nile"],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenZeppelin%2Fnile","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenZeppelin%2Fnile/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenZeppelin%2Fnile/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenZeppelin%2Fnile/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenZeppelin","download_url":"https://codeload.github.com/OpenZeppelin/nile/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253209228,"owners_count":21871612,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T06:00:51.704Z","updated_at":"2025-05-09T07:30:29.538Z","avatar_url":"https://github.com/OpenZeppelin.png","language":"Python","readme":"\u003e Disclaimer: this project is deprecated and no longer maintained. Check out [scarb](https://docs.swmansion.com/scarb/) instead.\n\n# OpenZeppelin | Nile ⛵\n\n[![Docs](https://img.shields.io/badge/docs-%F0%9F%93%84-blue)](https://docs.openzeppelin.com/nile)\n[![Tests and linter](https://github.com/OpenZeppelin/nile/actions/workflows/ci.yml/badge.svg)](https://github.com/OpenZeppelin/nile/actions/workflows/ci.yml)\n\n\u003e _Navigate your [StarkNet](https://www.cairo-lang.org/docs/hello_starknet/index.html) projects written in [Cairo](https://cairo-lang.org)._\n\n## Overview\n\nNile is a CLI tool to develop or interact with StarkNet projects written in Cairo. It consists of different components for developing, compiling, testing, and deploying your smart contracts and dApps, providing a CLI for executing tasks, and a Runtime Environment (NRE) for scripting. The package is designed to be extensible and very customizable by using plugins.\n\n## Documentation\n\nOn our [documentation site](https://docs.openzeppelin.com/nile) you can find:\n\n- [A Quickstart walkthrough with commands examples](https://docs.openzeppelin.com/nile#quickstart)\n- [Guides on how to master development with Nile](https://docs.openzeppelin.com/nile/testing)\n- [Useful script examples](https://docs.openzeppelin.com/nile/scripts#useful_script_examples)\n- [Plugins](https://docs.openzeppelin.com/nile/plugins)\n\nAnd more.\n\n## Installation\n\nCurrent supported Python versions are \u003e=3.9 and \u003c3.10.\n\n1. Install `gmp` on your machine (Cairo requirement).\n\n    ```\n    sudo apt install -y libgmp3-dev # linux\n    or\n    brew install gmp # mac\n    ```\n\n    If you have any trouble installing it on your Apple M1 computer, [here’s a list of potential solutions.](https://github.com/OpenZeppelin/nile/issues/22)\n\n\n2. Create a folder for your project and cd into it:\n\n    ```\n    mkdir myproject \u0026\u0026 cd myproject\n    ```\n\n3. Create a virtualenv and activate it:\n\n    ```\n    python3 -m venv env \u0026\u0026 source env/bin/activate\n    ```\n\n4. Install Nile:\n\n    ```\n    pip install cairo-nile\n    ```\n\n## Quickstart\n\nUse `nile init` to quickly set up your development environment:\n\n```\nnile init\n```\n```\n🗄 Creating project directory tree\n⛵️ Nile project ready! Try running:\n\nnile compile\n```\n\n## Contribute\n\nOpenZeppelin Nile exists thanks to its contributors. There are many ways you can participate and help build high quality software. Check out the [contribution](CONTRIBUTING.md) guide!\n\n## License\n\nNile is released under the MIT License.\n","funding_links":[],"categories":["Smart Contract Platforms"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOpenZeppelin%2Fnile","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOpenZeppelin%2Fnile","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOpenZeppelin%2Fnile/lists"}