Skip to main content

Project · editor · container — simplified

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

dev-code

     _                                _
    | |                              | |
  __| | _____   ________ ___ ___   __| | ___
 / _` |/ _ \ \ / /______/ __/ _ \ / _` |/ _ \
| (_| |  __/\ V /      | (_| (_) | (_| |  __/
 \__,_|\___| \_/        \___\___/ \__,_|\___|
  project · editor · container — simplified

Coverage PyPI version Python 3.10+ License: MIT

Reusable Dev Containers for any project — without modifying the repository.


Alt text

devcode is a CLI that opens any project in VS Code Dev Containers using reusable, local templates.

Define your environment once and reuse it across projects.


Why devcode?

Typical Dev Container workflows involve:

  • Copying .devcontainer/ directories between projects
  • Recreating environments repeatedly
  • Committing configuration to repositories you do not control

devcode separates environment configuration from project code:

  • Templates are stored locally
  • Projects remain unchanged
  • Containers are launched with a single command

Quick Start

# Install
pip install dev-code

# Create default template
devcode init

# Open a project
devcode open dev-code ~/projects/my-app

# Reopen projects later
devcode ps -a -i

Requirements

  • VS Code with the Dev Containers extension
  • Docker

Core Concepts

Templates

Templates are reusable devcontainer configurations stored locally.

Default location:

~/.local/share/dev-code/templates/

Override search paths:

DEVCODE_TEMPLATE_PATH=/my/templates:/team/templates
  • The first path is used for writes
  • Additional paths are read-only

Command Reference

Global Flags

-v, --verbose   Enable debug output

devcode open

devcode open <template> <path> [options]

Open a project using a template.

Arguments

  • <template>

    • Template name, or
    • Path to a devcontainer.json, or
    • Path to a directory containing it

    Paths must start with ./, ../, /, or ~/.

    If both a template and directory match, the template takes precedence and a warning is shown.

  • <path> Project directory

Options

Option Default Description
--dry-run Print resolved configuration and actions without executing
--container-folder <path> /workspaces/<project> Container mount path
--timeout <seconds> 300 Time to wait for container startup

devcode init

devcode init

Creates the default template.


devcode new

devcode new <name> [base]

Create a new template.

Argument Default Description
[base] dev-code Template to copy from

Options:

--edit

Open the template in VS Code after creation.


devcode edit

devcode edit [template]
  • With a name: opens that template
  • Without arguments: opens the templates directory

devcode list

devcode list [--long]
Option Description
--long Show full paths and grouped directories

devcode ps

devcode ps [-a] [-i]
Flag Description
-a Include stopped containers
-i Interactive reopen mode

Interactive mode prompts:

Open [1-N]:

Selecting a number reopens the project in VS Code.


devcode completion

devcode completion bash
devcode completion zsh

Enable in shell:

eval "$(devcode completion bash)"

Typical Workflow

devcode init
devcode new python-dev
devcode edit python-dev
devcode open python-dev ~/projects/my-app

Template System

Default Location

~/.local/share/dev-code/templates/

Custom Paths

DEVCODE_TEMPLATE_PATH=$HOME/my/templates:/team/shared/templates

Resolution order:

  1. First directory is the write target
  2. Remaining directories are used for lookup

File Injection (cp)

Inject files from the host into the container at startup.

Example

{
  "customizations": {
    "dev-code": {
      "cp": [
        {
          "source": "${localEnv:HOME}/.config/myapp",
          "target": "/home/vscode/.config/myapp"
        }
      ]
    }
  }
}

Fields

Field Required Description
source Yes Host path
target Yes Container path
override No Skip if target exists (default: false)
owner No Requires group
group No Requires owner
permissions No chmod applied recursively

Source Behavior

  • Supports ${localEnv:VAR}
  • Supports relative paths from .devcontainer/
  • Missing environment variables cause the entry to be skipped

Copy Directory Contents

Use /. suffix:

{
  "source": "${localEnv:HOME}/.config/myapp/.",
  "target": "/home/vscode/.config/myapp/"
}

Copies directory contents instead of the directory itself.


Behavior Rules

  • target/ copies into the directory
  • Without trailing / copies as a file or directory
  • override=false skips existing files
  • Ownership and permissions are applied after copying

Project Switching

devcode ps -a -i

Lists containers and allows reopening projects interactively.


Advanced Options

  • Multiple template directories
  • Template inheritance
  • Verbose debugging (-v)
  • Dry runs (--dry-run)
  • Custom container paths

Internal Flow

  1. Resolve template
  2. Resolve project path
  3. Launch VS Code Dev Container
  4. Apply file injection rules

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dev_code-0.1.9.tar.gz (291.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dev_code-0.1.9-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

Details for the file dev_code-0.1.9.tar.gz.

File metadata

  • Download URL: dev_code-0.1.9.tar.gz
  • Upload date:
  • Size: 291.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for dev_code-0.1.9.tar.gz
Algorithm Hash digest
SHA256 b654f197ee2373559011356c1e7e48ee7557efdc85029e6f9044fc8dd0170e16
MD5 0695756ea13c67ef7fa7c66785b6ad88
BLAKE2b-256 6bfab290a580cd57e2c564797d7b1e0ec8bd58de03a1853f58c00e6df5e15aa3

See more details on using hashes here.

Provenance

The following attestation bundles were made for dev_code-0.1.9.tar.gz:

Publisher: publish.yml on dacrystal/dev-code

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dev_code-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: dev_code-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 15.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for dev_code-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 8e1b9bae4559365d7173c96e4a32d3314e9eb3ac745773c50a583d81b7bf1ac7
MD5 edd678875f26de685b6b85aa1656309c
BLAKE2b-256 e42434296d98a0cbbad7e62b313f52ad9df02e4662583d6bf549b720cd38d76d

See more details on using hashes here.

Provenance

The following attestation bundles were made for dev_code-0.1.9-py3-none-any.whl:

Publisher: publish.yml on dacrystal/dev-code

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page