planet
: Libplanet CLI Tools
This CLI app is a collection of utilities for application programmers who create decentralized games powered by Libplanet.
Installation
There are multiple ways to install the planet
command. Pick the most handy
one for you.
npm
Install as an npm
package if npm
is installed on your system:
npm install @planetarium/cli
.NET Core tool
Install as a .NET Core tool if .NET Core SDK is installed on your system:
dotnet tool install -g Libplanet.Tools
Homebrew Cask
Install as a Homebrew cask if you use Homebrew on macOS:
brew install planetarium/brew/planet
Manual installation
Or you could just download an executable binary for your platform from
the releases page: planet-*-{linux,osx,win}-{x64, arm64}.{tar.xz,zip} files are
CLI tools. Linux (x64), macOS (x64, arm64), and Windows (x64) are supported.
Extract the binary to an appropriate directory in your PATH
.
Usage
planet --help
If you installed it using npm
without -g
/--global
option
use npx planet
command instead:
npx planet --help
Or if you installed it using .NET Core SDK without -g
/--global
option
use dotnet planet
command instead:
dotnet planet --help
Command-line completion
All subcommands and options can be completed in bash and zsh. You can
configure command-line completion through --completion
option.
For bash:
source <(planet --completion bash)
For zsh:
planet --completion zsh > ~/.zsh/functions
Note you don't configure it by yourself when you installed planet
using
Homebrew Cask.