Spheron CLI

🧰 CLI tool for creating and deploying dapps to web3.

Usage:

To use Spheron CLI, you need to first install it using the following command:

sudo npm install -g @spheron/cli

Once you have installed the CLI, you can use the following commands to create and deploy dapps to web3:

spheron init

Use spheron init to initialize a deployment configuration and create a Spheron configuration file in your project directory.

spheron init

spheron init [--import {DOCKER COMPOSE PATH}] [--dockerFile {DOCKERFILE PATH}] [--marketplace {APP ID}] You can update this file manually afterwards to change default settings.

Params options

import - relative path to docker compose file

dockerFile - relative path to dockerfile

marketplace - marketplace app ID

spheron deploy

Use spheron publish to deploy your instance — Uses the spheron.yaml file to launch your instance.

spheron deploy

This command will look up at your spheron.yaml file and use its configuration to deploy the instance.

spheron create-organization

Use spheron create-organization if you want to create a new organization. This will set that organization as default and will use it later for upload/publish commands by default. Keep in mind that first time you execute spheron login command, you will get new organization created if you already didn't have one set up.

spheron create-organization

This will open up a prompter that will help you set up your new organization. If you want to directly call it without prompter you can use:

spheron create-organization --name {organization_name} --username {organization_username}

Params options

name* - name of your organization

username* - username represent short name for your organization.

Note: * stands for mandatory (if all of mandatory params are not sent, prompter will be opened)

spheron login

Use spheron login to connect to your Spheron account. This command will allow you to authenticate to Spheron and is mandatory to execute before doing upload or publish commands.

spheron login

This will open up a prompter that will help you set up your new organization. If you want to directly call it without prompter you can use:

spheron login [--github | --gitlab | --bitbucket]

Learn More

You can learn more about Spheron and Spheron CLI here:

• Spheron Discord

• Spheron Twitter