Skip to main content

ctenv is a tool for running in containers as current user

Project description

ctenv

GitHub repo PyPI Changelog Tests License

Container environment as current user, in any image, preserving user identity.

Start container based on any image, with current directory mounted and runs as your own user in the container. Run a command or start an interactive shell.

Install

# Install with pip
$ pip install ctenv

# Install with uv
$ uv tool install ctenv

# Or run directly without installing
$ uv tool run ctenv --help

Recommend installing uv.

Usage

# Interactive shell in ubuntu container
$ ctenv run --image ubuntu -- bash

# Run a configured container
$ ctenv run my-node

# Run a custom command and mount a volume
$ ctenv run my-node --volume ./tests -- npm test

Why ctenv?

When running containers with mounted directories, files created inside often have root ownership or wrong permissions. ctenv solves this by:

  • Creating a matching user (same UID/GID) dynamically in existing images at runtime
  • Mounting your current directory with correct permissions
  • Using gosu to drop privileges after container setup

This works with any existing Docker image without modification - no custom Dockerfiles needed. Provides similar functionality to Podman's --userns=keep-id but works with Docker. Also similar to Development Containers but focused on running individual commands rather than persistent development environments.

Under the hood, ctenv starts containers as root for file ownership setup, then drops privileges using bundled gosu binaries before executing your command. It generates bash entrypoint scripts dynamically to handle user creation and environment setup.

Highlights

  • Works with existing images without modifications
  • Files created have your UID/GID (preserves permissions)
  • Convenient volume mounting like -v ~/.gitconfig (mounts to same path in container)
  • Simple configuration with reusable .ctenv.toml setups

Requirements

  • Python 3.10+
  • Docker (tested on Linux/macOS)

Features

  • User identity preservation (matching UID/GID in container)
  • Volume mounting with shortcuts like -v ~/.gitconfig (mounts to same path)
  • Volume ownership fixing with custom :chown option (similar to Podman's :U and :chown)
  • Post-start commands for running setup as root before dropping to user permissions
  • Template variables with environment variables, like ${env.HOME}
  • Configuration file support with reusable container definitions
  • Cross-platform support for linux/amd64 and linux/arm64 containers
  • Bundled gosu binaries for privilege dropping
  • Interactive and non-interactive command execution

Configuration

ctenv supports having a .ctenv.toml either in HOME or in project directores. When located in a project, it will use the path to the config file as project root.

Create .ctenv.toml for reusable container setups:

[defaults]
command = "zsh" # Run a shell for interactive use

[containers.python]
image = "python:3.11"
env = [
    "MY_API_KEY", # passed from environment when run
    "ENV=dev",
]
volumes = ["~/.cache/pip"]

Then run:

$ ctenv run python -- python script.py

Common Use Cases

Build Systems

Use containerized build environments:

[containers.build-system]
image = "some-build-system:v17"
volumes = ["build-cache:/var/cache:rw,chown"]

Development Tools

Run linters, formatters, or compilers from containers:

$ ctenv run --image rust:latest -- cargo fmt
$ ctenv run --image my-node-env -- eslint src/

Claude Code

Run Claude Code in a container for isolation with configuration for convenient usage:

~/.ctenv.toml:

# Run Claude Code in container
[containers.claude]
volumes = ["~/.claude.json", "~/.claude/"]
command = "claude" # Run claude directly

# Builds an image so you don't have to reinstall every time
[containers.claude.build]
dockerfile_content = """
FROM node:20
RUN npm install -g @anthropic-ai/claude-code
"""

Then start with: ctenv run claude

Detailed Examples

Claude Code

Basic example:

$ ctenv run --image node:20 -v ~/.claude.json -v ~/.claude/ --post-start-command "npm install -g @anthropic-ai/claude-code" -- claude

That would install it every time you run it. To avoid that, we can use ctenv to build an image with Claude Code:

$ ctenv run --build-dockerfile-content "FROM node:20\nRUN npm install -g @anthropic-ai/claude-code" -v ~/.claude.json -v ~/.claude/ -- claude

You likely want to configure this for conveniency:

# Run Claude Code in container
[containers.claude]
volumes = ["~/.claude.json", "~/.claude/"]
command = "claude" # Run claude directly

# Builds an image so you don't have to reinstall every time
[containers.claude.build]
dockerfile_content = """
FROM node:20
RUN npm install -g @anthropic-ai/claude-code
"""

If you have an existing image with a build environment already, use that and install Claude Code:

[containers.claude]
volumes = ["~/.claude.json", "~/.claude/"]
command = "claude"

[containers.claude.build]
dockerfile_content = """
FROM my-build-env:latest
RUN npm install -g @anthropic-ai/claude-code
"""

and run with: ctenv run claude

ctenv by default mounts the current directory as "workspace" and switches to it, so it would start Claude Code in with the current directory mounted in the container.

If you don't already have an image with your development tools in (node:20 doesn't include that much), you likely want to write a Dockerfile and install more tools in it for Claude and you to use.

[containers.claude.build]
dockerfile = "Dockerfile" # instead of dockerfile_content

Can for example also use iptables to restrict network access:

[containers.claude]
# ...
network = "bridge"
run_args = ["--cap-add=NET_ADMIN"]
post_start_commands = [
    "iptables -A OUTPUT -d 192.168.0.0/24 -j DROP",
]

Note: On macOS, Claude Code stores credentials in the keychain by default. When run in a container, it will create ~/.claude/.credentials.json instead, which persists outside the container due to the volume mount.

Note: There are also other tools for running Claude Code in a container, such as devcontainers: https://docs.anthropic.com/en/docs/claude-code/devcontainer

Build System with Caching

Complex build environment with shared caches:

[containers.build]
image = "registry.company.internal/build-system:v1"
env = [
    "BB_NUMBER_THREADS",
    "CACHE_MIRROR=http://build-cache.company.internal/",
    "BUILD_CACHES_DIR=/var/cache/build-caches/image-${image|slug}",
]
volumes = [
    "build-caches-user-${env.USER}:/var/cache/build-caches:rw,chown",
    "${env.HOME}/.ssh:/home/builduser/.ssh:ro"
]
post_start_commands = ["source /venv/bin/activate"]

This setup ensures the build environment matches the user's environment while sharing caches between different repository clones.

History

The background for ctenv was a bash script that I developed at work (Agama) for running our build system in a container. Besides running the build, it was useful to also be able to run and use the compiled code in the build system environment, which had older libraries than the modern OSes that was used by the developers.

ctenv is a much more generic tool than that bash script and without the many hard-coded parts. Written in Python and support for config files and much more.

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

ctenv-0.7.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

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

ctenv-0.7-py3-none-any.whl (1.9 MB view details)

Uploaded Python 3

File details

Details for the file ctenv-0.7.tar.gz.

File metadata

  • Download URL: ctenv-0.7.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ctenv-0.7.tar.gz
Algorithm Hash digest
SHA256 440b25ae847008d83bf7fcdf5fcfcd326f678df51b620a6e81cf0c61f2ca8013
MD5 d88cc85d304c3ae1107bd44658a3e1f6
BLAKE2b-256 28cbb8155b53c0f429991269da69e0428afa7f66c193ef1459a4573c524943f7

See more details on using hashes here.

Provenance

The following attestation bundles were made for ctenv-0.7.tar.gz:

Publisher: publish.yml on osks/ctenv

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

File details

Details for the file ctenv-0.7-py3-none-any.whl.

File metadata

  • Download URL: ctenv-0.7-py3-none-any.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ctenv-0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 94e1bcb57257b0bfd09437a77b09a7ccc9db2742866b159e5f46e1691fa55f57
MD5 b46271e2d5586efbe6945dd873c9838f
BLAKE2b-256 6539de77ca62b95480b534997a170a858d014d6bb81e97e5e49eed7139f23cac

See more details on using hashes here.

Provenance

The following attestation bundles were made for ctenv-0.7-py3-none-any.whl:

Publisher: publish.yml on osks/ctenv

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