This crate implements a set of tools for building and running Holochain DNA from the command line.
Our recommended pattern for the installation of hc command line tools is to download the binary for your platform from our releases page. Otherwise, you can proceed with the more complex instructions for building from source, below. Note, on Mac and Linux as well as installing the binaries you will need to install the zmq dependency e.g.:
On MacOS:
brew install zmq
On Ubuntu:
apt-get install libzmq3-dev
These dependencies need to be installed in order to compile, and use hc:
- Rust
- needs to be the
nightly-2019-01-24build, so use the following commands, once you have first installed Rust rustup toolchain install nightly-2019-01-24rustup default nightly-2019-01-24- (the specific nightly build we use will change over time)
- Also, if you are going to be developing Zomes in Rust, install the WASM build target for Rust, by running:
rustup target add wasm32-unknown-unknown --toolchain nightly-2019-01-24
- needs to be the
- Node.js version 8 or higher
- Tests for Holochain apps are now written in Javascript and executed in Nodejs
- To read further, check out the holochain-nodejs module
- Zmq
- zeromq is a "distributed messaging" software package utilized in the networking stack of Holochain
- the link above has common platform installation instructions
- without ZMQ the installation command that follows will fail
To install the latest version of the Holochain command line, run the following command in a terminal
$ cargo install hc --force --git https://github.com/holochain/holochain-rust.git --branch developThe command line tools are now available in your command line using the hc command.
Run hc --version to confirm.
Run hc help for help.
If you want to use hc run with real (as opposed to mock) networking, you will also need to install n3h.
(u) means the command is not yet implemented.
| Command | Use |
|---|---|
| init | Initializes a new Holochain app at the given directory |
| generate | Generates a new Zome |
| package | Builds the current Holochain app into a .dna.json file |
| unpack | Unpacks a Holochain bundle into its original file system structure |
| test | Runs tests written in the test folder |
| run | Starts a websocket server for the current Holochain app |
| agent (u) | Starts a Holochain node as an agent |
To read about hc init, used for starting a new Holochain project, see https://developer.holochain.org/guide/latest/new_project.html.
To read about hc generate, used for generating boilerplate code and files for a new Zome, see https://developer.holochain.org/guide/latest/zome/adding_a_zome.html.
To read about hc package, used for bundling your source files into a single file runnable by Holochain, see https://developer.holochain.org/guide/latest/packaging.html.
To read about hc test, used for running tests over your source code, see https://developer.holochain.org/guide/latest/intro_to_testing.html.
To read about hc run, used for spinning up a quick developement version of your app with an HTTP or Websocket interface, that you can connect to from a UI, or any client, see https://developer.holochain.org/guide/latest/running_an_app.html.
Holochain is an open source project. We welcome all sorts of participation and are actively working on increasing surface area to accept it. Please see our contributing guidelines for our general practices and protocols on participating in the community.
Copyright (C) 2018, Holochain Trust
This program is free software: you can redistribute it and/or modify it under the terms of the license p rovided in the LICENSE file (GPLv3). This program is distributed in the hope that it will be useful, bu t WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
Note: We are considering other 'looser' licensing options (like MIT license) but at this stage are using GPL while we're getting the matter sorted out. See this article for some of our thinking on licensing for distributed application frameworks.