Mediumroast for GitHub SDK

Administrative Subcommands

Mediumroast for GitHub CLI (Command Line Interface)

The CLI is divided into two sets one for administrative interactions with the system and another for interacting with Mediumroast for GitHub objects like Companies and Interactions. This document covers both the administrative CLI and makes reference to the CLI set for Mediumroast for GitHub objects.

Administrative CLIs

To enable setup and operational reporting of Mediumroast for GitHub several CLIs are available, each is described below.

User reporting

Reports on all users who can access the repository that contains the Mediumroast for GitHub. A screenshot showing the usage information and outputs for major functions is included below, and notice, user names and other personally identifiable information has been redacted from the screenshot below.

Command(s) run

  • mrcli u
  • mrcli u --my_user

Screenshot with ouput

users_util

Billing reporting

Provides reports for consumed actions and repository storage consumed by the organization that has installed and is using Mediumroast for GitHub. A screenshot showing the usage information and outputs for major functions is included below.

Command(s) run

  • mrcli b
  • mrcli b --storage
  • mrcli b --actions

Screenshot with ouput

billings_util

Setup

To help users quickly get on board with Mediumroast for GitHub the setup CLI is used. This CLI creates the ${HOME}/.mediumroast/config.ini file, creates the repository including key directories, and creates two initial companies. A screencast video showing the process for setting up the CLI environment and creating two companies is available below.

Command(s) run

  • mrcli setup

Screencast showing setup process

Notice: Only the markdown version rendered through the GitHub web interface will display the screencast. If you're viewing these files through the GitHub Page Version the link below will just show up as text.

https://github.com/mediumroast/mediumroast_js/assets/10818650/68c08502-4f59-4981-a001-0d9c9bd1d4d2

[Company Subcommand] | [Interaction Subcommand]