Skip to content

Latest commit

 

History

History
120 lines (80 loc) · 6.64 KB

README.md

File metadata and controls

120 lines (80 loc) · 6.64 KB
Raw

Command Launcher

A command launcher 🚀 made with ❤️

https://criteo.github.io/command-launcher/

Why a command launcher?

At Criteo, we have many teams who provides command line applications for developers. These CLI providers repeatly handle the same features and functionalities for their CLI apps, such as auto-completion, credential management, release, delivery, monitoring, etc.

On developer side, they have to manually download these tools to keep them up-to-date, it is difficult for them to discover available new tools. On the other hand, different developers have developed lots of similar handy scripts/tools by themselves without an easy way to share with others to avoid "re-invent" the wheel.

To improve both developer and CLI provider's experience, we developed a command launcher to solve the above issues. It has built-in features like auto-completion, credential management, progressive roll-out, and monitoring, so that the CLI app provider can focus on the functionality of their CLI app. Developers only need to download the command launcher to access all these CLI apps. The command launcher will keep their CLI application up-to-date. The dropin feature allows developers to integrate their own scripts/tools into command launcher and share with others. These scripts and tools can also benefits from built-in features like auto-completion, and monitoring.

How it works?

Command launcher is a small binary downloaded by developer in their development environment. CLI provider packages new commands or new version of command into a package, upload it to a remote repository, and update the package index of the repository. This process can be automated. More details about the remote repository, see CLI Provider Guide

Developers can integrate their own commands into command launcher as a "dropin" package. These dropin package will be only accessible from the developers themselves. To share such commands see Dropin Package

Developers run command launcher to access these commands, for example, you have a command called toto, instead of run it directly from command line, you use cola toto, where cola is the binary name of the command launcher, you can name it anything suits you. Every time you execute command launcher, it will synchronize with the remote command, and propose available updates if exists.


                           ┌──────────────────┐    Synch    ┌───────────────────────────┐
            ┌──────────────│ command launcher │◄────────────│ Remote Command Repository │
            │              └──────────────────┘             └───────────────────────────┘
            │                       │                                      │
            │            ┌──────────┼──────────┐              ┌────────────┼────────────┐
            ▼            ▼          ▼          ▼              ▼            ▼            ▼
       ┌─────────┐   ┌───────┐  ┌───────┐  ┌───────┐     ┌─────────┐  ┌─────────┐  ┌─────────┐
       │ dropins │   │ cmd A │  │ cmd B │  │ cmd C │     │  cmd A  │  │  cmd B  │  │  cmd C  │
       └────┬────┘   └───────┘  └───────┘  └───────┘     └─────────┘  └─────────┘  └─────────┘
     ┌──────┴──────┐
     ▼             ▼
 ┌────────┐   ┌────────┐
 │  cmd D │   │ cmd E  │
 └────────┘   └────────┘

Features

  • Small footprint. Command launcher is around 10M, with no dependency to your OS.
  • Technology agnostic. It can launch commands implemented in any technology, and integrate to it with a simple manifest file.
  • Auto-completion. It supports auto-completion for all your commands installed by it.
  • Auto-update. Not only keeps itself but all its commands up-to-date.
  • Credential management. With the built-in login command, it securely passes user credential to your command.
  • Progressive rollout. Target a new version of command to a group of beta test users, and rollout progressively to all your users.
  • Monitoring. Built-in monitoring feature to monitor the usage your commands.
  • Dropins. Easy to intergrate your own command line scripts/tools by dropping your manifest in the "dropins" folder.

Installation

Pre-built binary can be downloaded from the release page. Unzip it, copy the binary into your PATH.

The pre-built binary is named cdt (Criteo Dev Toolkit), if you want to use a different name, you can pass your prefered name in the build. See build section below.

Contribute

Build

Requirements: golang >= 1.17

You can build the command launcher with your prefered name (in the example: Criteo Developer Toolkit, a.k.a cdt).

go build -o cdt -ldflags='-X main.version=dev -X main.appName=cdt -X "main.appLongName=Criteo Dev Toolkit"' main.go

Or simply call the build.sh scripts

./build.sh [version] [app name] [app long name]

Run tests

Run unit tests

go test -v ./...

Run all integration tests

./test/integration.sh

You can run one integration test by specify the name of the integration test file (without the .sh extension). The integration tests can be found in test/integration folder, for example:

./test/integration.sh test-remote

Run pages locally

cd gh-pages && npm start

Run doc site locally

Run npm install at the root, and run npm start in gh-pages folder

Release

Simply tag a commit with format 'x.y.z', and push it.

git tag x.y.z
git push origin x.y.z

The supported release tag format:

  • *.*.*
  • *.*.*-*

Example: 1.0.0, 1.0.1-preview

Please make sure you have create an entry in release-notes.yaml file so that the release will generate the new version index for auto-update.