Op Tool Set Up

Updated 4 months ago by Shoreline

Supported operating systems

  • x86, 64 bit
  • Linux: Centos, Ubuntu
  • macOS
  • Windows: not supported at this time

Accessing Op

  • Option 1 - cURL the latest release, make the executable, and copy to your path (or add to another directory and add that to your path)
  • Option 2 - download from GitHub, make the executable, and copy to your path (or add to another directory and add that to your path)
  • Option 3 - download from the Shoreline website, make the executable, and copy to your path (or add to another directory and add that to your path)

Configuration

User specific configuration is stored in .ops.yaml in the user home directory.  The configuration file allows users to specify the following settings:

  • Debug mode
  • Output raw JSON
  • CLI output table default format
  • Additional formatting options (i.e. strings, numbers, time, labels)
  • Aliases
  • Linux commands

More details can be found here (external link needs to be added).

Access

Access to the Shoreline Op server is initiated via the AUTH command in the CLI:

op> auth <server url>

The auth command takes you to your organization’s identity management service where you enter your credentials to login into the Shoreline Op server.

How to Execute Commands

To start using Op, simply run the Op command.  This starts the Op interactive CLI shell which is the primary interface for operators.

op>

You can also execute Op commands from text files and stdin.  They are standard shell commands and can be natively invoked from existing Bash scripts and shells.

You can set it to verbose mode for detailed explanations by using the -v flag.  We recommend that you use verbose mode when starting out with Op to accelerate your ramp-up and also to assist with debugging.  Verbose output is written out to stdout.


How did we do?