Installation
Requirements
- Python 3.10+
- Git
- PostgreSQL (local)
- VS Code or Cursor (optional — for IDE integration)
Install
git clone https://github.com/chronofeldyx/cc.git ~/cc
cd ~/cc
./install.shThe installer will:
- Find Python 3.10+ on your system
- Create an isolated venv at
~/.cc-cli/venv(no system Python pollution) - Install cc-cli into the venv
- Add
~/.cc-cli/binto your PATH - Install shell integration (zsh, bash, or fish)
- Optionally run
cc setupfor first-time configuration
No pyenv required. No pip install into your system Python. cc lives entirely in its own venv and doesn't interfere with anything else.
With sync plugin
./install.sh --syncThis adds encrypted multi-device sync support. See the v3.3.0 changelog for details.
Upgrading from an older cc version
The installer handles upgrades automatically:
- Detects and removes old pip installs
- Cleans stale entries from your shell rc file
- Regenerates shell integration with correct paths
- Your database and settings at
~/.cc-cli/are preserved
Verify
Restart your terminal (or source ~/.zshrc), then:
ccYou should see the cc welcome screen with getting started instructions.
Optional: pyenv
cc integrates with pyenv to automatically activate the correct Python version when switching projects.
If pyenv is installed, cc will prompt you to link each Odoo version to a pyenv virtualenv during cc setup. On every cc switch, the terminal and VS Code interpreter will be updated automatically.
If pyenv is not installed, cc works fine — Python environment switching is simply skipped.
First Run
Run the configuration wizard:
cc setupThis walks you through:
- Where your Odoo installations are (auto-discovers versions and git branches)
- IDE preference, dump file directory, repo structure
- Timesheet and auto-fetch settings
- Shell integration and theme
You only need to do this once. The installer offers to run it for you at the end. Safe to re-run anytime — it pre-fills current values and skips steps already done.
For daily tweaks:
cc config— change a single settingcc theme— change the color themecc workspace add— register an additional Odoo versioncc shell install— reinstall shell integration after a dotfile reset
Next: Your First Switch