Skip to content
/ cli Public
forked from devcontainers/cli

A reference implementation for the specification that can create and configure a dev container from a devcontainer.json.

License

Notifications You must be signed in to change notification settings

joshspicer/cli

Repository files navigation

Dev Container CLI

This repository holds the dev container CLI, which can take a devcontainer.json and create and configure a dev container from it.

Context

A development container allows you to use a container as a full-featured development environment. It can be used to run an application, to separate tools, libraries, or runtimes needed for working with a codebase, and to aid in continuous integration and testing. Dev containers can be run locally or remotely, in a private or public cloud.

Diagram of inner and outerloop development with dev containers

This CLI is in active development. Current status:

  • dev-containers-cli build - Enables building/pre-building images
  • dev-containers-cli up - Spins up containers with devcontainer.json settings applied
  • dev-containers-cli run-user-commands - Runs lifecycle commands like postCreateCommand
  • dev-containers-cli read-configuration - Outputs current configuration for workspace
  • dev-containers-cli exec - Executes a command in a container with userEnvProbe, remoteUser, remoteEnv, and other properties applied
  • dev-containers-cli stop - Stops containers
  • dev-containers-cli down - Stops and deletes containers

Specification

The dev container CLI is part of the Development Containers Specification. This spec seeks to find ways to enrich existing formats with common development specific settings, tools, and configuration while still providing a simplified, un-orchestrated single container option – so that they can be used as coding environments or for continuous integration and testing.

Learn more on the dev container spec website.

Additional resources

You may review other resources part of the specification in the devcontainers GitHub organization.

Contributing

Check out how to contribute to the CLI in CONTRIBUTING.md.

License

This project is under an MIT license.

About

A reference implementation for the specification that can create and configure a dev container from a devcontainer.json.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages

  • TypeScript 92.4%
  • Shell 3.4%
  • JavaScript 3.2%
  • Other 1.0%