cleancoindev/holochain-cmd

command line tool for Holochain

Holochain Command Line Tools

holochain-cmd is a set of tools for building and running Holochain applications from the command line. The tools are written in Rust, and delivered as binary executables.

How To Install

Prerequisite: Rust must be installed on your computer

To install the Holochain command line , run the following commands in a terminal

$ git clone https://github.com/holochain/holochain-cmd.git
$ cd holochain-cmd
$ cargo install -f --path .

The command line tools are now available in your command line using the hcdev command. Run hcdev -V to confirm. Run hcdev help for help.

Available Commands

(u) means the command is as-yet unimplemented.

Command	Use
agent (u)	Starts a Holochain node as an agent
generate	Generates a new zome and scaffolds the given capabilities
init	Initializes a new Holochain app at the given directory
package	Builds the current Holochain app into a .hcpkg file
unpack	Unpacks a Holochain bundle into its original file system structure
web (u)	Starts a web server for the current Holochain app

How To Get Started Building An App

In your terminal, change directories to one where you wish to initialize a new Holochain app. Run the following, replacing your_app_name with your actual app name:

$ hcdev init your_app_name
$ cd your_app_name

We now have the empty shell of a Holochain app. From here, we will want to generate at least one Zome. To do this, run the following, replacing your_zome_name with a name related to the functionality you wish to develop. For example: users.

$ hcdev generate zomes/your_zome_name rust

Currently, Zomes can be generated as rust, or as assemblyscript. hcdev generate scaffolds the files and config you need to get started. In the command above, we declared rust just to be explicit, even though it's the default language.

What this did is generate a new folder under zomes called users. Here is the folder structure of it.

• users
  • code
    • src
      • main.rs
    • .build
    • Cargo.toml
  • zome.json

So in a given Zome we have two things:

1. a JSON file, zome.json, which defines and configures the Zome
2. a code folder, which can be compiled into a single WASM file with the code for this Zome

In order for Holochain to run your app, you have to build your code into a single packaged file. Those instructions follow.

What are .hcpkg files?

A Holochain app can be fully contained in a file known as a .hcpkg file. It is a JSON file, with a particular structure that Holochain can understand, and execute.

This is an unusual JSON file; it is part configuration, and part executable.

The configuration part comes from the json files that are throughout your app. One at the top level for the application (app.json) and one for each Zome. Ultimately, these get stitched together into a single tree structure in the .hcpkg file.

The executable part comes from having embedded Base64 encoded WebAssembly code in the file. What does that mean? WebAssembly is a fast and secure low-level language. Rather than storing the code in its ugly raw WASM bytecode format, Holochain expects the code to be encoded using Base64 , for legibility and simplicity reasons.

If you haven't heard of WebAssembly (WASM for short), that's ok. Important to know is that WASM is intended as a "compilation target" for other languages, not a language to write code in. So instead of writing code in WASM, write code in a language that's familiar to you, and supports WASM. When it's time to run your code in Holochain, compile it.

In order to avoid having to handcraft this complex JSON structure, with lots of room for error, the hcdev package command streamlines the process of taking your "raw" application folder, and packaging it up into the final .hcpkg file.

More information about this follows.

Using Built-in Compilation

The hcdev package tool will automate the process of compiling your Zome code, encoding it, and inserting into the .hcpkg file. In order to get these benefits, you just need to make sure that you have the right compilation tools installed on the machine you are using the command line tools from, and that you have the proper configuration files in your Zome folders.

hcdev package works with two special files called .hcignore files and .build files.

.build files

In the process of building a .hcpkg file, here is what Holochain does.

• It iterates Zome by Zome adding them to the JSON
• For each Zome, it looks for any folders containing a .build file
• For any folder with a .build file, it executes one or more commands from the .build file to create a WASM file
• It takes that built WASM file and Base64 encodes it, then stores a key/value pair for the Zome with the key as the folder name and the encoded WASM as the value

When using hcdev generate to scaffold a Zome, you will have a .build file automatically. If you create your Zome manually however, you will need to create the file yourself. Here's the structure of a .build file, using a Rust Zome which builds using Cargo as an example:

{
  "steps": {
    "cargo": [
      "build",
      "--release",
      "--target=wasm32-unknown-unknown"
    ]
  },
  "artifact": "target/wasm32-unknown-unknown/release/code.wasm"
}

The two top level properties are steps and artifact. steps is a list of commands which will be sequentially executed to build a WASM file. artifact is the expected path to the built WASM file. Under steps, each key refers to the bin of the command that will be executed, such as cargo. The value of cargo, the command, is an array of arguments: build, and the two -- flags. In order to determine what should go here, just try running the commands yourself from a terminal, while in the directory of the Zome code.

Ignoring using .hcignore files

Sometimes, you'll want to exclude files and folders in your project directory to get a straight .hcpkg file that can be understood by Holochain. In order to do that, just create a .hcignore file. It has a similar structure to .gitignore files:

README.md
dist
.DS_Store

The package command includes patterns inside .gitignore files automatically, so you don't have to write everything twice. Also hidden files are ignored by default as well.

Rust -> WASM compilation tools

If we take Zome code in Rust as an example, you will need Rust and Cargo set up appropriately to build WASM from Rust code. WASM compilation is available on the nightly Rust toolchain. To enable it, run the following:

$ rustup toolchain install nightly
$ rustup target add wasm32-unknown-unknown --toolchain nightly # adds WASM as a compilation target
$ rustup default nightly # switch to the nightly rust toolchain as your default

Once that's done, you should be able to run commands like cargo build --target=wasm32-unknown-unknown and have it work.

Once all of this is set up, you can build and run your .hcpkg file with Holochain!