Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 1.62 KB

README.md

File metadata and controls

43 lines (31 loc) · 1.62 KB

Ship

The Spaceship CLI tool


Ship is a small CLI tool for working with the Spaceship platform.

Commands

Ship provides several commands, with some still in development. You can see the ones currently available by running ship with no command or ship help to get more detailed help output.

Currently implemented commands will be checked off below:

  • login - Logs ship into your Spaceship account.
  • logout - Logs ship out of the currently logged-in Spaceship account.
  • configure-docker - Sets up Docker authentication to the Magic Container Registry.
  • setup-delivery - Sets up delivery of an app to your current Kubernetes cluster.
  • 🔳 create-k8s-app - Set up a Deployment in Kubernetes for the current repo. (Note: This is planned to be a separate tool as well)
  • 🔳 install-agent - Installs the Spaceship Agent into your current Kubernetes cluster.
  • 🔳 deliveries - Gets a list of recent deliveries.
  • 🔳 builds - Gets a list of recent builds.
  • 🔳 ship it - Starts a delivery for the current repo. :shipit:

Development

Ship requires go 1.20 or higher to build.

Contributing

  1. Fork the repo
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request here on GitHub