Authentication & Config
Understanding Your Crab Environment
When troubleshooting or filing a bug report, you need a snapshot of how Crab is configured in your current environment. crab env prints everything relevant in one command: version info, remote URL, filter driver settings, and active environment variables.
Usage
crab envcrab version 0.8.3 (a1b2c3d)
git version 2.44.0
Remote=crab://my-bucket/my-repo
Bucket=my-bucket
RepoPath=my-repo
git config filter.crab.process = "crab filter-process"
git config filter.crab.clean = "crab clean %f"
git config filter.crab.smudge = "crab smudge %f"
git config filter.crab.required = "true"
Environment:
AWS_REGION=us-east-1
AWS_PROFILE=defaultThe command works both inside and outside a Crab repository. Outside a repo, remote and filter sections show <not configured>.
Output Sections
| Section | What it shows |
|---|---|
| Version | Crab version string and git commit SHA |
| Git version | Installed git version (or "git not found") |
| Remote | Configured crab remote URL, parsed into bucket and repo path |
| Filter configuration | Git config values for the crab filter driver |
| Environment variables | Relevant set variables (AWS_REGION, AWS_PROFILE, CRAB_LOG, CRAB_CACHE_DIR, etc.) |
Unset environment variables are omitted from the output.
Common Uses
Include in a bug report
crab env > /tmp/crab-env.txt
# Attach to your issueVerify setup after initialization
crab init crab://my-bucket/my-repo
crab env # confirm everything is wired upCheck in CI pipelines
crab env --jsonThe JSON output is useful for automation scripts that need to parse environment details programmatically:
{
"schema": "env",
"version": "1.0",
"data": {
"crab_version": "0.8.3",
"git_sha": "a1b2c3d4e5f6",
"build_timestamp": "2026-04-20T10:00:00Z",
"git_version": "git version 2.44.0",
"remote_url": "crab://my-bucket/my-repo",
"platform": "aarch64-unix-macos"
}
}CLI Reference
For complete command syntax and all available flags, see the crab env reference.