run-in-container

CLI to assist running commands inside containers

Overview

Supported container CLIs:

• Docker
• Podman

Features:

• Ability to detect available runtimes, and prompt for which one to use
• Interactive configuration

Planned:

• Ability to store default arguments, such as volumes, ports, etc

Table Of Contents

• run-in-container
• Overview
• Table Of Contents
• Usage
• Commands

Usage

$ npm install -g run-in-container
$ run-in-container COMMAND
running command...
$ run-in-container (-v|--version|version)
run-in-container/0.2.2 linux-x64 node-v12.15.0
$ run-in-container --help [COMMAND]
USAGE
  $ run-in-container COMMAND
...

Commands

• run-in-container autocomplete [SHELL]
• run-in-container commands
• run-in-container conf [KEY] [VALUE]
• run-in-container help [COMMAND]
• run-in-container init
• run-in-container run [CONTAINER OPTIONS]

run-in-container autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ run-in-container autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ run-in-container autocomplete
  $ run-in-container autocomplete bash
  $ run-in-container autocomplete zsh
  $ run-in-container autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

run-in-container commands

list all the commands

USAGE
  $ run-in-container commands

OPTIONS
  -h, --help  show CLI help
  -j, --json  output in json format
  --hidden    also show hidden commands

See code: @oclif/plugin-commands

run-in-container conf [KEY] [VALUE]

manage configuration

USAGE
  $ run-in-container conf [KEY] [VALUE]

ARGUMENTS
  KEY    key of the config
  VALUE  value of the config

OPTIONS
  -d, --cwd=cwd          config file location
  -d, --delete           delete?
  -h, --help             show CLI help
  -k, --key=key          key of the config
  -n, --name=name        config file name
  -p, --project=project  project name
  -v, --value=value      value of the config

See code: conf-cli

run-in-container help [COMMAND]

display help for run-in-container

USAGE
  $ run-in-container help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

run-in-container init

Run the initial configuration setup

USAGE
  $ run-in-container init

See code: src/commands/init.ts

run-in-container run [CONTAINER OPTIONS]

Run a container. Similar to 'docker run'.

USAGE
  $ run-in-container run [CONTAINER OPTIONS]

OPTIONS
  -i, --[no-]interactive
  -t, --[no-]tty
  -v, --volume=volume

DESCRIPTION
  Run a container. Similar to 'docker run'. 
  Any unrecognized arguments will be passed directly to the underlying CLI

EXAMPLES
  $ run-in-container run alpine echo "Hello world"
  $ run-in-container run --interactive --tty alpine sh
  $ run-in-container run --no-interactive --no-tty alpine sh
  $ run-in-container run -it alpine

See code: src/commands/run.ts