/gtmhub-cli

A CLI tool for gtmhub

Primary LanguageGoMIT LicenseMIT

A great okr platform needs great tools; we're excited to introduce Gtmhub CLI, our next generation command line experience for Gtmhub.

Prerequisites

The only thing you need to successfully run the gtmhub-cli tool is an active subscription with the best okr platform.

Installation

Mac

brew tap gtmhub/homebrew-gtmhub
brew install gtmhub-cli

Windows

choco install gtmhub-cli

Linux

curl https://raw.githubusercontent.com/gtmhub/gtmhub-cli/master/distribution/linux/install.sh | bash

Usage

 gtmhub [command] [subcommand] {parameters}

Login

Use the login command to authenticate. As Gtmhub supports multiple data centers you will need to login against the correct data centre. The default one is EU. In case your account is located in Gtmhub's US data centre use the dc flag and pass the value for us.

gtmhub login --dc us

supported commands

  1. login - authorizes the tool to access your gtmhub instance and perform actions on your behalf.
  2. logout - removes the integration with your account
  3. status - displays items that need your attention
  4. update - lets you update your key results
  5. get - a group of commands that allows you to get various items from gtmhub
    • lists - lets you iteract with gtmhub lists
    • krs - lets you get information about your key results

Exit codes

For scripting purposes, we output certain exit codes for differing scenarios.

Exit Code Scenario
0 Command ran successfully.
1 Generic error; most likely the gtmhub server returned an error code. Enable debug for more information
2 Parser error; check input to command line.