2 unstable releases
Uses new Rust 2024
| 0.2.0 | Jan 9, 2026 |
|---|---|
| 0.1.0 | Jan 1, 2026 |
#713 in Command line utilities
27KB
416 lines
🌿 Eden
Developer onboarding preflight checks.
Eden is a Rust-powered CLI tool that verifies required dependencies and configurations are properly installed before development begins. Run one command to ensure your dev environment is ready.
Installation
cargo install eden-cli
Quick Start
- Initialize a config file in your project root:
eden init
Or create an eden.toml manually:
[checks]
binaries = ["docker", "node", "bun"]
environment = ["DATABASE_URL"]
- Run the preflight check:
eden check
Example output:
🌱 Binary: docker - v29.1.3 (/usr/bin/docker)
🌱 Binary: node - v25.2.1 (/usr/bin/node)
🌱 Binary: bun - v1.3.5(/usr/bin/bun)
🥀 Env: DATABASE_URL - not set
🌱 3 sprouted, 🥀 1 needs water
Configuration
Eden supports multiple config formats:
- TOML:
eden.toml - YAML:
eden.yaml/eden.yml - JSON:
eden.json/eden.jsonc
Generate a starter config:
eden init
eden init --format yaml
If no --format is specified, Eden will default to TOML.
Config Options
[checks]
# binaries that must be in PATH
binaries = [
"git",
"docker",
"node",
]
# environment variables that must be set
environment = [
"DATABASE_URL",
"API_KEY",
]
CLI Reference
eden check # run all checks (default)
eden check -c custom.toml # use custom config file
eden init # create starter config
eden --help # show help
eden --version # show version
Use Cases
- New Developer Onboarding: Include in your README as the first setup step
- CI/CD Pipelines: Verify environments before running tests
- Pre-commit Hooks: Ensure environment consistency
- Documentation: Self-documenting project requirements
Roadmap
- Version constraints for binaries (
node >= 18) - Interactive fix mode (
eden fix) - Network connectivity checks
- Disk space checks
- Custom script validators
- Host JSON schema on the internet
Development
Version Syncing
Eden uses a dual-package setup (Rust crate + npm package) with automated version synchronization:
- Source of truth:
package.jsonholds the canonical version, and is used for Changesets - Sync script:
scripts/syncVersion.tspropagates the version toCargo.toml - Changesets: Manages version bumps and changelog generation
The sync script runs automatically during the release process via the version npm script:
bun run version # syncs `package.json` version → `Cargo.toml`
CI/CD
Two GitHub workflows handle versioning:
| Workflow | Trigger | Purpose |
|---|---|---|
sync.yml |
Push/PR to master |
Validates versions match, runs tests, builds artifacts |
release.yml |
Push to master |
Creates releases via Changesets, builds multi-platform binaries |
The sync workflow will fail if package.json and Cargo.toml versions diverge.
Release Process
- Create a changeset:
bun changeset - Push to
master - Changesets action creates a "Version Packages" PR
- Merge the PR to trigger a release with binaries for:
x86_64-unknown-linux-gnuaarch64-unknown-linux-gnux86_64-apple-darwinaarch64-apple-darwin
- Manually publish to crates.io:
cargo publish
License
The code in this repository is licensed under MIT, © Omni LLC. See LICENSE.md for more information.
Dependencies
~3.5–7MB
~138K SLoC