|
2 | 2 |
|
3 | 3 | A command-line tool for managing Credential Engine platform resources. |
4 | 4 |
|
5 | | -All commands follow the format: |
6 | | - |
7 | | -``` |
8 | | -ce <noun> [<noun>] <verb> [--<parameters>] |
9 | | -``` |
10 | | - |
11 | 5 | ## Requirements |
12 | | - |
13 | | -- Python 3.10+ |
14 | | - |
| 6 | + |
| 7 | +- Python 3.10 or later |
| 8 | +- `pip` |
15 | 9 | ## Installation |
16 | | - |
| 10 | + |
| 11 | +> **Recommended:** install inside a virtual environment. This avoids file-permission errors, PATH conflicts, and "invalid distribution" warnings from previous installs. |
| 12 | + |
| 13 | +### Option 1: Install from source with a virtual environment (recommended) |
| 14 | + |
| 15 | +**macOS / Linux:** |
| 16 | + |
17 | 17 | ```bash |
| 18 | +git clone https://github.com/CredentialEngine/ce-cli.git |
| 19 | +cd ce-cli |
| 20 | + |
| 21 | +python3 -m venv .venv |
| 22 | +source .venv/bin/activate |
| 23 | + |
18 | 24 | pip install -e . |
19 | 25 | ``` |
| 26 | + |
| 27 | +**Windows (PowerShell):** |
| 28 | + |
| 29 | +```powershell |
| 30 | +git clone https://github.com/CredentialEngine/ce-cli.git |
| 31 | +cd ce-cli |
| 32 | + |
| 33 | +python -m venv .venv |
| 34 | +.venv\Scripts\activate |
| 35 | + |
| 36 | +pip install -e . |
| 37 | +``` |
| 38 | + |
| 39 | +When the venv is active you'll see `(.venv)` in your prompt, and `ce` is automatically on `PATH`. To leave the venv, run `deactivate`. To re-enter it next time, run the activate command above from the project folder. |
| 40 | + |
| 41 | +### Option 2: Install from a release |
| 42 | + |
| 43 | +1. Download the `.whl` from the [Releases page](https://github.com/CredentialEngine/ce-cli/releases). |
| 44 | +2. Install it (inside a venv is still recommended): |
| 45 | + ```bash |
| 46 | + pip install ce_cli-<version>-py3-none-any.whl |
| 47 | + ``` |
| 48 | + |
| 49 | + ### Upgrading |
| 50 | + |
| 51 | +From a release `.whl`: |
| 52 | + |
| 53 | +```bash |
| 54 | +pip install --upgrade ce_cli-<version>-py3-none-any.whl |
| 55 | +``` |
| 56 | + |
| 57 | +From source: `git pull` and re-run `pip install -e .` inside your venv. |
| 58 | + |
| 59 | +### Option 3: Install from source without a venv |
| 60 | + |
| 61 | +```bash |
| 62 | +git clone https://github.com/CredentialEngine/ce-cli.git |
| 63 | +cd ce-cli |
| 64 | +pip install -e . |
| 65 | +``` |
| 66 | + |
| 67 | +This puts the `ce` command on your `$PATH`. On Windows, see the [Windows PATH note](#windows-path-note) below if `ce` isn't found. |
| 68 | + |
| 69 | +### Verify the installation |
| 70 | + |
| 71 | +```bash |
| 72 | +ce --help |
| 73 | +``` |
| 74 | + |
| 75 | +You should see the top-level command list. |
| 76 | + |
| 77 | +### Windows PATH note |
| 78 | + |
| 79 | +When you install on Windows without a venv, pip often drops ce.exe into your user Scripts folder, which Windows doesn't put on PATH by default: |
| 80 | + |
| 81 | +``` |
| 82 | +C:\Users\<you>\AppData\Roaming\Python\Python310\Scripts |
| 83 | +``` |
| 84 | + |
| 85 | +If `ce --help` fails after install, either use a venv (recommended) or add that folder to your User PATH: |
| 86 | + |
| 87 | +```powershell |
| 88 | +[Environment]::SetEnvironmentVariable( |
| 89 | + "Path", |
| 90 | + $env:Path + ";C:\Users\$env:USERNAME\AppData\Roaming\Python\Python310\Scripts", |
| 91 | + "User" |
| 92 | +) |
| 93 | +``` |
| 94 | + |
| 95 | +Then **close and reopen PowerShell** existing windows won't pick up the new PATH. |
| 96 | + |
20 | 97 |
|
21 | | -This puts the `ce` command on your `$PATH`. |
22 | 98 |
|
23 | 99 | ## Quick start |
24 | 100 |
|
|
0 commit comments