edosrecki / oopsiee-cli

A CLI tool for oopsiee-server. Simplifies daily operations and on-call duty by letting you run repeated and cumbersome tasks with one-liners.

oOPSiee 🙈

A CLI tool for oopsiee-server. Simplifies daily operations and on-call duty by letting you run repeated and cumbersome tasks with one-liners.

• Supports synchronous commands

• Supports asynchronous jobs

• Easily extensible

• Simple installation and configuration

• Comes with help entries

• Runs on all platforms

• Uses private/public key authentication

  • Supports encrypted private keys and integrates with ssh-agent

• Written in TypeScript

• Semi-automatic dependency updates with Dependabot

---

• Installation
  • Homebrew
  • Releases
  • Build from source
• Usage
  • Configure
    • Encrypted private key?
  • Help
  • Run command
• Run
  • Development mode
  • Distribution mode
• Build
• Package
  • Pre-configured
  • Manual
• Test
• Deploy

Installation

Homebrew

brew install edosrecki/tools/oopsiee

# To update:
brew upgrade oopsiee

Releases

Download a corresponding distribution from Releases and add the executable to your PATH.

Build from source

Optionally, you can also build it from source by building and packaging it manually - see Build and Package sections.

Usage

Configure

1. Add your public key to oopsiee-server.

2. Log into oopsiee-cli:

> oopsiee login
? Username: foobar
? Private key file path: ~/.ssh/id_rsa

Encrypted private key?

Encrypted private keys are supported via ssh-agent, which needs to be configured:

oopsiee config set user.ssh-agent-socket <SSH_AGENT_SOCKET>

Help

oopsiee help
oopsiee help <COMMAND>

Run command

# Run synchronously/asynchronously (whichever is default for command)
oopsiee <COMMAND> [ARGS] [OPTS]

# Force command to run synchronously
oopsiee <COMMAND> [ARGS] [OPTS] --sync

# Force command to run asynchronously
oopsiee <COMMAND> [ARGS] [OPTS] --async

# Fetch results of asynchronous command execution
oopsiee job <ID>

Run

Development mode

npm run exec:dev -- <COMMAND> [ARGS] [OPTS]

Distribution mode

npm run exec:dist -- <COMMAND> [ARGS] [OPTS]

Build

npm run clean
npm run build

Package

Pre-configured

# Packages for Node.JS 12 on MacOS, Linux, and Windows
npm run bundle

Manual

See pkg for details.

npx pkg <NODE_RANGE>-<PLATFORM>-<ARCH>

# Examples
npx pkg node8-macos-x64
npx pkg node10-linux-x86
npx pkg node6-win-x64

Test

npm test
npm run test:watch

Deploy

To deploy a new version of oopsiee-cli, merge master branch into release branch. New version will automatically get released by CI system.

oopsiee-cli's Issues

Use SSH_AUTH_SOCK environment variable

If a private key is encrypted, oOPSiee will try to use ssh-agent to sign the request. To use ssh-agent a socket has to be configured.

Currently, it has to be explicitly set by running oopsiee config set user.ssh-agent-socket <SOCKET>.

If user.ssh-agent-socket config variable is not set, oOPSiee should try to use SSH_AUTH_SOCK environment variable.

Add 'oopsiee login' command

Instead of asking users to set config variables one by one, oOPSiee should have an oopsiee login command which would prompt user for necessary details and use sensible defaults for ones that are not mandatory.

Example:

> oopsiee login
Username: edosrecki
Private key file path: (~/.ssh/id_rsa) ~/.ssh/some_other_private_key

The automated release is failing 🚨

🚨 The automated release from the release branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the release branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

No npm token specified.

An npm token must be created and set in the NPM_TOKEN environment variable on your CI environment.

Please make sure to create an npm token and to set it in the NPM_TOKEN environment variable on your CI environment. The token must allow to publish to the registry https://registry.npmjs.org/.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀