CDX

CDX — a fast, focused command-line tool that helps developers and teams manage projects, tasks, and settings from the terminal.

Why CDX exists

• Problem: Developers waste time switching tools and writing repetitive setup scripts.
• Solution: CDX centralizes common project operations (create, configure, run tasks) with simple commands so you can spend time building, not managing.

Key benefits

• Save time: Quick project scaffolding and repeatable commands.
• Consistency: Standardize workflows across machines and teams.
• Lightweight: Focused feature set that integrates with your existing stack.

Core features

• Create new projects from templates: cdx create <name>
• Configure project and user settings: cdx config set <key> <value>
• Authentication helpers for secure workflows: cdx auth login / logout
• Task runner for common routines: cdx run <task>
• Scriptable and CI-friendly: works in scripts and automation pipelines

Install

• From npm: npm install -g cdx
• From local folder: npm install -g .

Quick start

1. Create a project
   • cdx create my-app
2. Set configuration
   • cdx config set editor vim
3. Run a task
   • cdx run build
4. Authenticate (uses secure storage or environment-driven flow)
   • cdx auth login

Examples

• Create and bootstrap:
  • cdx create blog && cd blog && cdx run init
• Save a setting:
  • cdx config set project.timeout 30

Configuration

• Use cdx config get/set to manage settings.
• Configured values can be sourced from environment variables or secure stores; avoid storing sensitive secrets in plaintext files.

Security & privacy

• Do not commit passwords, API keys, or private tokens to version control.
• Prefer environment variables, system keychains, or dedicated secret managers for credentials.
• CDX is designed to avoid embedding sensitive provider-specific implementation details in the README or default configs.

Best practices

• Add CDX commands to project README or contributor docs for consistent onboarding.
• Use CI environment variables for automation rather than local secrets.
• Create lightweight templates for teams to standardize projects.

Contribution

• Found a bug or have a feature idea? Open an issue or submit a pull request.
• Keep changes small and well-documented. Add tests for new behavior where possible.

License

• See package.json for the license. Ensure you follow the license when redistributing.

Support & contact

• Open an issue in the repository for help or feature requests.
• Include command output and steps to reproduce when reporting bugs.

Thank you for using CDX — built to reduce repetitive work and help teams move faster.