https://github.com/walnuthq/noir-libs
Noir Packages registry for Aztec Network CLI
https://github.com/walnuthq/noir-libs
aztec-network blockchain noir noir-lang noir-language
Last synced: 2 months ago
JSON representation
Noir Packages registry for Aztec Network CLI
- Host: GitHub
- URL: https://github.com/walnuthq/noir-libs
- Owner: walnuthq
- Created: 2024-12-07T09:46:52.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-02-11T11:03:55.000Z (2 months ago)
- Last Synced: 2025-02-11T12:22:40.391Z (2 months ago)
- Topics: aztec-network, blockchain, noir, noir-lang, noir-language
- Language: Rust
- Homepage: https://noir-libs.org
- Size: 286 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-noir - noir-libs
README
# noir-libs: Noir Package Manager CLI
`noir-libs` is a CLI application for the Noir Package Manager [noir-libs.org](https://noir-libs.org/).
## Installation
Install the CLI: `curl -s https://raw.githubusercontent.com/walnuthq/noir-libs/main/install.sh | bash`
Usage: `noir-libs --help`
## Features
The following features are supported:
- Add a package from the package repository to a project: `noir-libs add @`.
If no version is specified, the latest version will be fetched e.g. `noir-libs add aztec`
- Remove a package from a project: `noir-libs remove `
### Supported packages
All supported packages are available at [noir-libs.org](https://noir-libs.org/).
## Package locations
Fetched packages are stored in a cache folder. The exact location depends on the operating system:
- Linux: `/home/user/.cache/noir-libs/`
- macOS: `/Users/user/Library/Application Support/com.walnut.noir-libs/`
- Windows: `C:\Users\Alice\AppData\Local\walnut\noir-libs`
## Building from source
Build `noir-libs` using the following command: `cargo build --release`.
## Testing
1. Get the example package `example.tar.gz` from `tests/test_files` and extract it to an unrelated folder.
1. Ensure you have everything set up for [Aztec development](https://docs.aztec.network/guides/getting_started).
1. Try compiling the example with: `aztec-nargo compile`. It should fail due to missing dependencies.
1. Install `noir-libs` by following the instructions in the Installation section above.
1. In your example folder, add the necessary dependencies using the following commands:
1. `noir-libs add easy_private_state`
1. `noir-libs add aztec`
1. `noir-libs add value_note`
1. Compile again with `aztec-nargo compile`
2. Check that everything worked this time.
## Acknowledgments
A lot of inspiration for noir-libs was taken from [scarb](https://github.com/software-mansion/scarb), built by [Software Mansion](https://swmansion.com/).