FAQ
Quick answers to common questions. See also Troubleshooting if you’re stuck.
General
Section titled “General”What is coderaft?
Section titled “What is coderaft?”A tool that creates isolated development environments using Docker containers (called “islands”). Code stays on host, tools run in the island.
What platforms are supported?
Section titled “What platforms are supported?”Linux (Debian, Ubuntu, Fedora, Arch, Alpine, and more), macOS, and Windows. See Installation.
Where are project files stored?
Section titled “Where are project files stored?”On host: ~/coderaft/<project>/. Inside island: /island/.
Does coderaft require root?
Section titled “Does coderaft require root?”No, but Docker requires membership in the docker group. Inside islands, commands run as root by default for setup convenience.
Where is configuration stored?
Section titled “Where is configuration stored?”- Global:
~/.coderaft/config.json - Project:
coderaft.jsonin your workspace - Secrets:
~/.coderaft/secrets.vault.json(encrypted)
How do I create a project?
Section titled “How do I create a project?”coderaft init <project> [--template python|nodejs|go|web]How do I enter the environment?
Section titled “How do I enter the environment?”coderaft shell <project>How do I run a command?
Section titled “How do I run a command?”coderaft run <project> "<command>"How do I expose ports?
Section titled “How do I expose ports?”Add to coderaft.json:
{ "ports": ["3000:3000", "8000:8000"] }How do I see what ports are exposed?
Section titled “How do I see what ports are exposed?”coderaft ports [project]Shows all exposed ports with clickable URLs and auto-detected service names.
How do I store secrets/API keys?
Section titled “How do I store secrets/API keys?”coderaft secrets init # One-time setupcoderaft secrets set <project> API_KEYcoderaft secrets import <project> .envSecrets are stored encrypted (AES-256) and can be exported for use.
How do I share with teammates?
Section titled “How do I share with teammates?”Commit coderaft.json. Teammates run coderaft up.
How do I stop auto-stop behavior?
Section titled “How do I stop auto-stop behavior?”Use --keep-running or set "restart": "unless-stopped" in config.
Management
Section titled “Management”How do I list projects?
Section titled “How do I list projects?”coderaft listHow do I remove a project?
Section titled “How do I remove a project?”coderaft destroy <project>Files remain on host unless manually deleted.
How do I update environments?
Section titled “How do I update environments?”coderaft update [project]Are package installs recorded?
Section titled “Are package installs recorded?”Yes. Installs from 30+ package managers (apt, pip, npm, cargo, go, gem, brew, conda, etc.) are logged to /island/coderaft.history. Downloads via wget/curl and make install are also tracked. These commands are replayed on rebuild.
Advanced
Section titled “Advanced”Can I set resource limits?
Section titled “Can I set resource limits?”{ "resources": { "cpus": "2", "memory": "4g" } }Can I use Podman instead of Docker?
Section titled “Can I use Podman instead of Docker?”Set CODERAFT_ENGINE=podman.
How do I mount dotfiles?
Section titled “How do I mount dotfiles?”coderaft up --dotfiles ~/.dotfilesOr add "dotfiles": ["~/.dotfiles"] to config.
- Docs: coderaft.ar0.eu
- GitHub: itzcozi/coderaft