https://github.com/TravonteD/devc

A convenient cli wrapper around the devcontainer-cli
https://github.com/TravonteD/devc

devcontainer devcontainers

Last synced: 3 months ago
JSON representation

A convenient cli wrapper around the devcontainer-cli

• Host: GitHub
• URL: https://github.com/TravonteD/devc
• Owner: TravonteD
• Created: 2023-01-23T14:45:15.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-10T17:12:43.000Z (about 1 year ago)
• Last Synced: 2024-06-11T01:25:06.391Z (5 months ago)
• Topics: devcontainer, devcontainers
• Language: Shell
• Homepage:
• Size: 36.1 KB
• Stars: 9
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# devc: A convenient wrapper around the [devcontainer-cli](https://github.com/devcontainers/cli)

## Features

- A tui interface based on [gum](https://github.com/charmbracelet/gum)

- Automatically handles removal of containers, images, and volumes created by the cli

- Adds the following new functionality

  + `shell`: Starts a shell in the devcontainer at the workspace directory

  + `edit`: A quick shortcut for opening your `devcontainer.json` with your favorite editor (Be sure to export `EDITOR` for this functionality)

  + `kill`: Does a full shutdown and removal of the current devcontainer 

  + `restart`: Does a quick reboot of the devcontainer

  + `rebuild`: Kills the devcontainer and starts a new one from scratch

## Installation

- Install the following dependencies:

  - `jq`

  - `gum`

  - `devcontainer`

- Update the `makefile` with your desired installation directory and command name

- Run `make install`

## Usage

```bash

devc [command]

```

Available commands:

  - up : Starts the dev-container

  - exec : Runs a single command in the container

  - background : Same as `exec` in the background

  - edit : Opens the `.devcontainer/devcontainer.json` in your `$EDITOR`

  - shell : Starts an interactive shell in the container at the workspace folder

  - stop : Stops the container without removing it

  - kill : Removes the container, image, and volume for the container

  - restart : Reboots the container

  - rebuild : Equivalent to **kill** + **up**