https://github.com/planetarium/9crun
A CLI app to manage and execute different versions of NineChronicles Headless nodes
https://github.com/planetarium/9crun
Last synced: about 2 months ago
JSON representation
A CLI app to manage and execute different versions of NineChronicles Headless nodes
- Host: GitHub
- URL: https://github.com/planetarium/9crun
- Owner: planetarium
- License: agpl-3.0
- Created: 2024-08-30T05:22:33.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-11-19T22:44:01.000Z (5 months ago)
- Last Synced: 2025-01-21T03:11:17.162Z (3 months ago)
- Language: C#
- Size: 34.2 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NineChronicles.Headless.Executor
This project provides a command-line interface (CLI) to manage and execute different versions of [NineChronicles Headless][9c-headless] nodes. You can install, list, and run the headless node for specific networks such as `MainnetOdin`, `MainnetHeimdall`, or `Single`.
## Prerequisites
- .NET SDK 6.0 or later
- Internet connection for downloading headless versions and necessary configuration files
## Building from source
You can build and run from source:
```bash
git clone
cd 9crun
cd src/NineChronicles.Headless.Executor
dotnet build
dotnet run -- [options]
```
## Commands
### Install
Install a specific version of NineChronicles Headless:
```bash
dotnet run -- install [--os ]
```
- ``: The version of NineChronicles.Headless to download.
- `--os`: Optionally specify the OS platform (auto-detected if not provided).
### List Versions
List installed versions or remote versions available for download:
```bash
dotnet run -- versions [--remote] [--page ]
```
- `--remote`: If provided, lists remote versions available for download.
- `--page`: Specifies the page number for pagination of remote versions.
### Run
Run a specific version of NineChronicles Headless on a given network:
```bash
dotnet run -- run
```
- ``: The version of NineChronicles.Headless to run.
- ``: The network to run the headless node on (e.g., `MainnetOdin`, `MainnetHeimdall`, `Single`).
The `run` command automatically downloads the necessary configuration files (e.g., templates, genesis block) if they are not already present locally.
To run version `v100000` of NineChronicles Headless on the `MainnetOdin` network:
```bash
dotnet run -- run v100000 MainnetOdin
```
## Configuration
The project automatically downloads the necessary configuration files, such as templates and genesis blocks, when running the headless node. These files are saved in user directories for reuse.
- Configuration templates are stored in `~/.planetarium/headless/templates/`.
- Genesis blocks are stored in `~/.planetarium/headless/genesis-block/`.
[9c-headless]: https://github.com/planetarium/NineChronicles.Headless