Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/metaplex-foundation/sugar
Candy Machine Rust CLI.
https://github.com/metaplex-foundation/sugar
blockchain metaplex nft rust solana
Last synced: about 1 month ago
JSON representation
Candy Machine Rust CLI.
- Host: GitHub
- URL: https://github.com/metaplex-foundation/sugar
- Owner: metaplex-foundation
- License: apache-2.0
- Created: 2022-01-24T17:50:51.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-26T20:59:25.000Z (about 2 months ago)
- Last Synced: 2024-09-28T09:42:57.380Z (about 2 months ago)
- Topics: blockchain, metaplex, nft, rust, solana
- Language: Rust
- Homepage:
- Size: 1.82 MB
- Stars: 201
- Watchers: 11
- Forks: 116
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://crates.io/crates/sugar-cli)
[](https://crates.io/crates/sugar-cli)
[](https://img.shields.io/github/stars/metaplex-foundation/sugar?style=social)
[](https://img.shields.io/github/forks/metaplex-foundation/sugar?style=social)
[](https://img.shields.io/github/v/release/metaplex-foundation/sugar)
[](https://github.com/metaplex-foundation/sugar/actions/workflows/build.yml)
[](https://github.com/metaplex-foundation/sugar/blob/main/LICENSE)
# Sugar: A Candy Machine CLI
Sugar is an alternative to the current [Metaplex Candy Machine](https://developers.metaplex.com/candy-machine) CLI. It has been written from the ground up and includes several improvements:
- better performance for upload of media/metadata files and deploy of the candy machine — these operations take advantage of multithreaded systems to significantly speed up the computational time needed;
- simplified build and installation procedures taking advantage of `cargo` package management, including a binary distributable package ready to use;
- robust error handling and validation of inputs, including improvements to config and cache files, leading to more informative error messages.
See [the docs](https://developers.metaplex.com/candy-machine/sugar) for full installation and usage instructions.
## Installation
### Recommended Method
For macOS, Linux and Windows Subsystem Linux (WSL), run the following install script in your terminal:
```bash
bash <(curl -sSf https://raw.githubusercontent.com/metaplex-foundation/sugar/main/script/sugar-install.sh)
```
For Windows:
Download [this installer binary](https://github.com/metaplex-foundation/winstaller/releases/latest/download/winstaller.exe) and execute it. Since it is not a verified Windows binary you may have to choose "Run Anyway" from "More Info" on the pop-up Windows dialog.
> **Dependencies:**
> When installing on Ubuntu or WSL (Windows Subsystem Linux), you may need to install some additional dependencies:
>
> ```bash
> sudo apt install libudev-dev pkg-config unzip
> ```
### Developers
Using Crates.io:
```bash
cargo install sugar-cli
```
Build From Source:
```bash
cargo install --path ./
```
## Quick Start
Set up your Solana CLI config with an RPC url and a keypair:
```bash
solana config set --url --keypair
```
Sugar will then use these settings by default if you don't specify them as CLI options, allowing commands to be much simpler.
Create a folder named `assets` to store your json and media file pairs with the naming convention 0.json, 0., 1.json, 1., etc., where the extension is `.png`, `.jpg`, etc. This is the same format described in the [Candy Machine v2 documentation](https://developers.metaplex.com/candy-machine/sugar/getting-started#preparing-your-files).
You can then use the `launch` command to start an interactive process to create your config file and deploy a Candy Machine to Solana:
```bash
sugar launch
```
At the end of the execution of the `launch` command, the Candy Machine will be deployed on-chain.