CLI Quick Start

The Valist CLI allows you to easily publish, download, and install releases from the command line! It's a great way to easily work with releases without navigating through a frontend. You can also use it to integrate your existing CI/CD workflows.
Features
The Valist CLI supports all of the core functionality of Valist, including:
Secure key management with keytar​
Publishing releases, for example valist publish acme-co/go-binary/0.0.1 dist/*
Downloading releases, for example valist download acme-co/go-binary
Gasless meta-transactions powered by OpenGSN​
Installation
To install the CLI, you will need Node.js v16+ installed.
1
npm install -g @valist/cli
Copied!
Importing a key into the CLI wallet
The Valist CLI supports importing the following key formats:
Private Key Hex string
Encrypted JSON Keystore (MyCrypto, Geth, etc)
Mnemonic phrase
To import your key into your secure keystore, run the following:
1
valist import
Copied!
This will prompt you to import the key into your system's secure credential storage. You will then be able to use this key for publishing.
Your key is only accessible by you -- this simply copies your key into your system's native secure keystore.
Create an account & project
To publish with the CLI, you first need to create an account & project at the Web Dashboard.
For more information, visit:
Creating an Account
Creating a Project
Publishing a Release
Publishing a Release with the CLI is very simple. You simply need to give it the account/project/tag path to publish at, and the set of files to include in the Release.
The format is the following:
1
valist publish <username>/<project>/<version> <folder>/**
Copied!
An example of this looks like:
1
valist publish acme-co/go-binary/0.0.1 dist/**
Copied!
You can also include multiple folders and files. The file paths support glob patterns as well:
1
valist publish acme-co/go-binary/0.0.2 dist/** src/** README.md
Copied!
This will upload the files to IPFS, and trigger the publish. Meta-transactions are enabled by default, so you won't need to spend any gas.
This is a flexible and simple way to publish in any environment that supports Node.js!
Downloading a Release
Downloading a Release with the CLI is just as easy.
Simply provide the release path, and it will download a .tar bundle containing the Release:
1
valist download acme-co/go-binary/0.0.1
Copied!
If you don't specify a tag, the CLI will automatically download the latest Release:
1
valist download acme-co/go-binary
Copied!
Voila! This will fetch the Release metadata and the corresponding artifacts from IPFS into your working directory.
​

GitHub Action - Previous

Publishing Source Code Snapshots

Next - Web

Publishing Releases

Last modified 9d ago

Export as PDF

Copy link

Contents

Features

Installation

Importing a key into the CLI wallet

Create an account & project

Publishing a Release

Downloading a Release