Crate holochain_cli[−][src]
Expand description
A library and CLI to help create, run and interact with holochain conductor setups. Warning this is still WIP and subject to change There’s probably a few bugs. If you find one please open an issue or make a PR.
CLI
The hc
CLI makes it easy to run a dna that you are working on
or someone has sent you.
It has been designed to use sensible defaults but still give you
the configurability when that’s required.
Setups are stored in tmp directories by default and the paths are
persisted in a .hc
file which is created wherever you are using
the CLI.
Install
Requirements
Building
From github:
cargo install holochain_cli --git https://github.com/holochain/holochain
From the holochain repo:
cargo install --path crates/hc
Common usage
The best place to start is:
hc -h
This will be more up to date then this readme.
Run
This command can be used to generate and run conductor setups.
hc run -h
hc r -h
In a folder with where your my-dna.dna
is you can generate and run
a new setup with:
hc r
If you have already created a setup previously then it will be reused (usually cleared on reboots).
Generate
Generates new conductor setups and installs apps / dnas.
hc generate
hc g
For example this will generate 5 setups with app ids set to my-app
using the elemental-chat.dna
from the current directory with a quic
network setup to localhost.
You don’t need to specify dnas when they are in the directory.
hc gen -a "my-app" -n 5 ./elemental-chat.dna network quic
You can also generate and run in the same command: (Notice the number of conductors and dna path must come before the gen sub-command).
hc r -n 5 ./elemental-chat.dna gen -a "my-app" network quic
Call
Allows calling the [AdminRequest
] api.
If the conductors are not already running they
will be run to make the call.
hc call list-cells
List and Clean
These commands allow you to list the persisted setups
in the current directory (from the.hc
) file.
You can use the index from:
hc list
Output:
hc-sandbox:
Setups contained in `.hc`
0: /tmp/KOXgKVLBVvoxe8iKD4iSS
1: /tmp/m8VHwwt93Uh-nF-vr6nf6
2: /tmp/t6adQomMLI5risj8K2Tsd
To then call or run an individual setup (or subset):
hc r -i=0,2
You can clean up these setups with:
hc clean 0 2
hc clean
Library
This crate can also be used as a library so you can create more complex setups / admin calls. See the docs:
cargo doc --open
and the examples.
Enums
Holochain CLI