Starship CLI

starship is the command-line interface designed to deploy and manage Starship, catering specifically to Node.js and TypeScript developers. This CLI tool offers a seamless and intuitive interface that dramatically simplifies the development, testing, and deployment of interchain applications across both local environments and CI/CD pipelines.

Designed with simplicity and speed in mind, Starship enables developers to quickly integrate Starship into their blockchain projects without complex orchestration.

Table of contents

• StarshipJS
• Table of contents
• Install
• Recommended Usage
  • Deploying Starship
  • Running End-to-End Tests
  • Teardown
• CLI Usage
  • CLI Examples
  • CLI Commands
  • CLI Options
• Developing
• Credits

Install

Install @starship-ci/cli with npm or yarn:

npm install @starship-ci/cli

Recommended Usage 📘

Stay tuned for a create-cosmos-app boilerplate! For now, this is the most recommended setup. Consider everything else after this section "advanced setup".

• We recommend studying the osmojs starship integration and replicating it.
• Add your configs, similar to how it's done here
• Add your workflows for GitHub Actions like this
• Add yarn starship commands to your package.json scripts like this — Note the jest configurations in the osmojs package

Using with CI/CD

Install the packages

Install @starship-ci/cli and starshipjs

yarn add --dev starshipjs @starship-ci/cli

Add your configuration files, similar to these:

• Example config.yaml

• Example starship.yaml

• Example jest.config.js

Update your package.json scripts:

"starship": "starship --config ./starship/configs/starship.yaml",
"starship:test": "jest --config ./jest.starship.config.js --verbose --bail",
"starship:watch": "jest --watch --config ./jest.starship.config.js"

See an example here.

Start starship 🚀

yarn starship start

Manual setup & start

yarn starship setup
yarn starship deploy
yarn starship start-ports

Stopping starship

yarn starship stop

This will allow you to run yarn starship to start, setup, deploy, stop and other starship commands:

Deploying Starship 🚀

yarn starship start

Running End-to-End Tests 🧪

# test
yarn starship:test

# watch 
yarn starship:watch

Teardown 🛠️

# stop ports and delete deployment
yarn starship stop

CLI Usage

Install the CLI

While it's not recommended due to upgrades and package management, you can install globally:

npm install -g @starship-ci/cli

CLI Examples

Here are some common usages of the starship CLI:

starship setup --helmFile ./config/helm.yaml --helmName my-release
starship deploy --helmFile ./config/helm.yaml --helmName my-release
starship undeploy --config ./config/settings.json
starship setup-kind
starship start-ports
starship stop-ports
starship upgrade
starship teardown
starship clean

CLI Commands

Here's a concise overview of the commands available in the starship CLI:

| Command | Description | | ---------------- | ----------------------------------------------- | | start | Setup, Deploy, and Start Ports. | | setup | Setup initial configuration and dependencies. | | deploy | Deploy starship using specified options or configuration file. | | start-ports | Start port forwarding for the deployed services. | | stop-ports | Stop port forwarding. | | teardown | Remove all components related to the deployment. | | upgrade | Upgrade the deployed application to a new version. | | undeploy | Remove starship deployment using specified options or configuration file. | | delete-helm | Delete a specific Helm release. | | remove-helm | Remove Helm chart from local configuration. | | setup-kind | Setup a Kubernetes kind cluster for development. | | clean-kind | Clean up Kubernetes kind cluster resources. | | clean | Perform a clean operation to tidy up resources. | | version, -v | Display the version of the Starship Client. |

CLI Options

Options in the CLI allow for dynamic configuration of starship. You can specify individual options directly in the command line to fine-tune the behavior of the tool. Alternatively, you can use the --config option to specify a YAML configuration file that sets up the initial parameters. If both methods are used, any options provided directly in the command line will override the corresponding settings in the configuration file, giving you the flexibility to customize specific aspects of the deployment without altering the entire configuration.

| Option | Description | |--------------------|-------------------------------------------------------| | --config <path> | Specify the path to the JSON configuration file containing all settings. | | --no-tty | for CI/CD, it's a good idea to set --no-tty to disable interactive prompts | | --helmFile <path>| Specify the path to the Helm file. | | --helmName <name>| Specify the Helm release name. | | --helmRepo <repo>| Specify the Helm repository. | | --helmRepoUrl <url> | Specify the Helm repository URL. | | --helmChart <chart> | Specify the Helm chart. | | --helmVersion <ver> | Specify the version of the Helm chart. | | --kindCluster <name> | Specify the name of the Kubernetes kind cluster. | | --verbose | Enable verbose output for debugging purposes. | | --curdir <dir> | Specify the current working directory of the operation. |

Developing

When first cloning the repo:

yarn
yarn build

Related

Checkout these related projects:

• @cosmology/telescope Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules.
• @cosmwasm/ts-codegen Convert your CosmWasm smart contracts into dev-friendly TypeScript classes.
• chain-registry Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application.
• cosmos-kit Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
• create-cosmos-app Set up a modern Cosmos app by running one command.
• interchain-ui The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit.
• starship Unified Testing and Development for the Interchain.

Credits

🛠 Built by Cosmology — if you like our tools, please consider delegating to our validator ⚛️

Disclaimer

AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.

No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.