cycloid-cli

README

Cycloid CLI (cy)

This repository hosts the source code of Cycloid command line to use Cycloid APIs.

Getting started

Before playing with the CLI, you first need to authenticate a user into the Cycloid API:

cy login --org my-org --email example@email.com --password my-password --api-url https://cycloid-api.local.tld

From there, you can now explore the various commands using the --help flag for each command / subcommand.

$ cy help
Cy is a CLI for Cycloid framework. Learn more at https://www.cycloid.io/.

Usage:
  cy [command]

Available Commands:
  catalog-repository Manage the catalog repositories
  completion         Output shell completion for the given shell (bash or zsh)
  config-repository  Manage the catalog repositories
  credential         Manage the credentials
  event              Manage the events
  external-backend   manage external backends
  help               Help about any command
  infrapolicy        Manage infrapolicies
  login              Login against the Cycloid console
  members            Manage members from the organization
  organization       Manage the organizations
  pipeline           Manage the pipelines
  project            Manage the projects
  roles              Manage roles from the organization
  stack              Manage the stacks
  status             Get the status of the Cycloid services
  terracost          Use terracost feature
  version            Get the version of the consumed API

Installation

From the sources

You can clone the repository and build from sources (we use Go Modules (1.13+)):

git clone git@github.com:cycloidio/cycloid-cli.git
cd cycloid-cli

Build and install the binary

make build
sudo mv cy /usr/local/bin
cy --version

From the releases page

You can download the latest Linux binary from the release page.

Common actions

Get the Cycloid services in an unhealthy state

cy status -o json | jq '.[] | select( .status != "Success")'

Create config repository using credential named "Git Config"

GIT_CRED=$(cy --org $ORG credential list -o json | jq '.[] | select( .name == ""Git Config") | .id')
cy --org myorg  config-repository create --branch master --cred $GIT_CRED --name "lab-config" --default --url "git@github.com:org/repo.git"

Invite members with "Admin" role

ADMIN_ROLE=$(cy --org $ORG  roles list -o json | jq '.[] | select( .name | contains("Admin")) | .id')
cy  --org myorg  members invite --role-id $ADMIN_ROLE --email foo@email.com

🚧

Contributing

Have a look to our CONTRIBUTING.md

License

This project is under MIT License, see LICENSE