@open-containers-manager/cli

CLI app to use podman & buildah through VirtualBox VM "seamlessly"

Usage no npm install needed!

<script type="module">
  import openContainersManagerCli from 'https://cdn.skypack.dev/@open-containers-manager/cli';
</script>

README

Open Containers Manager

CLI app to use podman & buildah through VirtualBox VM "seamlessly"

NPM Package Travis CI Codacy grade License

Features

  • Download and install OCM VirtualBox VM
  • Expose Podman & Buildah commands seamlessly
  • Automatic forwarding of the exposed port in the virtual machine from containers to host
  • Automatic mount of the current directory in the virtual machine for build commands
  • Persistent storage in separate VMDK (~/.ocm/ocm-persistent.vmdk)

Limitations

  • Podman build & Buildah build-using-dockerfile, bud, add, copy, unshare commands should be used with a relative path under current directory (current directory is mounted in the virtual machine)
  • Mounting a host volume in containers is not supported
  • Remove OCM virtual machine from VirtualBox removes persistent storage, detaches it before

Requirements

  • Linux, MacOS X or Windows with nodejs v10.
  • VirtualBox

Install

npm -g i @open-containers-manager/cli

or from source

npm i
npm run build
npm -g i file:$PWD

Exposes four global commands : ocm, podman, buildah and ocm-daemon.

Usage

OCM

Usage:
  ocm [command]

Available commands:
  install     Download & install OCM VM
  status      Display the status of the OCM VM
  start       Start the OCM VM
  stop        Stop the OCM VM
  console     Open an interactive console

Podman

Use "podman --help" for more informations about command.

Buildah

Use "buildah --help" for more informations about command.

OCM Daemon

Starts automatically in background with each of the above commands if it is not already active.

ocm-daemon

Can be started manually before ocm start command for debugging purposes

License

MIT © Tony Duburque