Accessing via CLI
The English user guide is currently in beta preview. Most of the documents have been automatically translated from the Japanese version. Should you find any inaccuracies, please reach out to Flatt Security.
The shishoctl
CLI is a tool for operating Shisho Cloud. With this tool, you can deploy and manage policies on Shisho Cloud, creating an experience comparable to using the docker
or kubectl
commands.
Installation
You can install shishoctl
as follows:
- Linux (amd64)
- Linux (arm64)
- macOS (Intel CPU)
- macOS (Apple Silicon)
- Windows (amd64)
Please run the following to install shishoctl
to /usr/local/bin
:
SHISHOCTL_URL="https://shisho.dev/releases/shishoctl-0.11.0-x86_64-unknown-linux-gnu"
sudo curl -L $SHISHOCTL_URL -o /usr/local/bin/shishoctl
sudo chmod +x /usr/local/bin/shishoctl
Please run the following to install shishoctl
to /usr/local/bin
:
SHISHOCTL_URL="https://shisho.dev/releases/shishoctl-0.11.0-aarch64-unknown-linux-gnu"
sudo curl -L $SHISHOCTL_URL -o /usr/local/bin/shishoctl
sudo chmod +x /usr/local/bin/shishoctl
Please run the following to install shishoctl
to /usr/local/bin
:
SHISHOCTL_URL="https://shisho.dev/releases/shishoctl-0.11.0-x86_64-apple-darwin"
sudo curl -L $SHISHOCTL_URL -o /usr/local/bin/shishoctl
sudo chmod +x /usr/local/bin/shishoctl
Please run the following to install shishoctl
to /usr/local/bin
:
SHISHOCTL_URL="https://shisho.dev/releases/shishoctl-0.11.0-aarch64-apple-darwin"
sudo curl -L $SHISHOCTL_URL -o /usr/local/bin/shishoctl
sudo chmod +x /usr/local/bin/shishoctl
Run the binary for Linux on WSL, or you can download .exe file from https://shisho.dev/releases/shishoctl-0.11.0-x86_64-pc-windows-gnu.exe running on Windows.
Sign in
By running the following command in an environment where the shishoctl
command can be executed, you can sign in to Shisho Cloud from shishoctl
:
shishoctl auth signin
The authentication information obtained from Shisho Cloud by the shishoctl auth signin
command becomes invalid after a certain period. If an error regarding authentication status occurs, please rerun the shishoctl auth signin
command.
Example: Fetching a List of Workflows
Once successfully signed in via the shishoctl
CLI, you can perform a range of operations on Shisho Cloud using shishoctl
. For example, the following command retrieves a list of workflows registered to the organisation ID org-a
:
shishoctl workflow list -o org-a
The organization ID refers to the ID registered when creating an organization. If the organization ID is unclear, please follow the steps below to check it:
- Open the Shisho Cloud dashboard in a web browser.
- Check the organization ID (the
[oid]
part) included in the URL displayed on the web browser, as shown below:
https://cloud.shisho.dev/[oid]/dashboard
Checking How to Use Other Commands
For additional information about the shishoctl
command, look through the other pages of this website or use the following command:
shishoctl --help