run-in-container/README.md

CLI to assist running commands inside containers

# run-in-container

CLI to assist running commands inside containers

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/run-in-container.svg)](https://npmjs.org/package/run-in-container)
[![Codecov](https://codecov.io/gh/robertsmieja/run-in-container/branch/master/graph/badge.svg)](https://codecov.io/gh/robertsmieja/run-in-container)
[![Downloads/week](https://img.shields.io/npm/dw/run-in-container.svg)](https://npmjs.org/package/run-in-container)
[![License](https://img.shields.io/npm/l/run-in-container.svg)](https://github.com/robertsmieja/run-in-container/blob/master/package.json)

# 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

<!-- toc -->
* [run-in-container](#run-in-container)
* [Overview](#overview)
* [Table Of Contents](#table-of-contents)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Usage

<!-- usage -->
```sh-session
$ 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
...
```
<!-- usagestop -->

# Commands

<!-- commands -->
* [`run-in-container autocomplete [SHELL]`](#run-in-container-autocomplete-shell)
* [`run-in-container commands`](#run-in-container-commands)
* [`run-in-container conf [KEY] [VALUE]`](#run-in-container-conf-key-value)
* [`run-in-container help [COMMAND]`](#run-in-container-help-command)
* [`run-in-container init`](#run-in-container-init)
* [`run-in-container run [CONTAINER OPTIONS]`](#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](https://github.com/oclif/plugin-autocomplete/blob/v0.1.5/src/commands/autocomplete/index.ts)_

## `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](https://github.com/oclif/plugin-commands/blob/v1.2.3/src/commands/commands.ts)_

## `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](https://github.com/natzcam/conf-cli/blob/v0.1.9/src/commands/conf.ts)_

## `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](https://github.com/oclif/plugin-help/blob/v2.2.3/src/commands/help.ts)_

## `run-in-container init`

Run the initial configuration setup

```
USAGE
  $ run-in-container init
```

_See code: [src/commands/init.ts](https://github.com/robertsmieja/run-in-container/blob/v0.2.2/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](https://github.com/robertsmieja/run-in-container/blob/v0.2.2/src/commands/run.ts)_
<!-- commandsstop -->