You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Follow-up to #132: the skill's management.md still said `pipx install
cocoindex-code` and described `ccc init` as a purely non-interactive
command. Update to reflect:
- Two install styles — `[default]` (batteries included) vs bare
(slim, LiteLLM-only).
- First-run `ccc init` is interactive; prompts for provider/model and
runs a test embed via the daemon.
- `--litellm-model MODEL` flag for non-TTY / scripted use.
- Pointer to `ccc doctor` if the init model test fails.
Copy file name to clipboardExpand all lines: skills/ccc/references/management.md
+21-6Lines changed: 21 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,15 @@
2
2
3
3
## Installation
4
4
5
-
Install CocoIndex Code via pipx:
5
+
Install CocoIndex Code via pipx. Two install styles:
6
6
7
7
```bash
8
-
pipx install cocoindex-code
8
+
pipx install 'cocoindex-code[default]'# batteries included (local embeddings via sentence-transformers)
9
+
pipx install cocoindex-code # slim (LiteLLM-only; requires a cloud embedding provider + API key)
9
10
```
10
11
12
+
The `[default]` extra pulls in `sentence-transformers` so the first-run default (local embeddings, no API key) works out of the box. The slim install is for environments where you don't want the torch/transformers deps and plan to use a LiteLLM-supported cloud provider instead.
13
+
11
14
To upgrade to the latest version:
12
15
13
16
```bash
@@ -24,15 +27,27 @@ Run from the root directory of the project to index:
24
27
ccc init
25
28
```
26
29
27
-
This creates:
28
-
-`~/.cocoindex_code/global_settings.yml` (user-level settings, e.g., model configuration) if it does not already exist.
**First run (global settings don't exist yet)** — `ccc init` prompts interactively for the embedding provider (sentence-transformers / litellm) and model, then runs a one-off test embed via the daemon to confirm the model works. Accept the defaults for the sentence-transformers path, or pick litellm and enter a model identifier.
31
+
32
+
**Subsequent runs** (global settings already exist) — prompts are skipped; only project settings and `.gitignore` are set up.
33
+
34
+
To skip the interactive prompts on the first run (e.g. in a script or container), pass `--litellm-model MODEL`:
If `.git` exists in the directory, `.cocoindex_code/` is automatically added to `.gitignore`.
32
47
33
48
Use `-f` to skip the confirmation prompt if `ccc init` detects a potential parent project root.
34
49
35
-
After initialization, edit the settings files if needed (see [settings.md](settings.md) for format details), then run `ccc index` to build the initial index.
50
+
After initialization, edit the settings files if needed (see [settings.md](settings.md) for format details), then run `ccc index` to build the initial index. If the model test printed `[FAIL]` during `init`, edit `global_settings.yml` (and optionally add API keys under the commented `envs:` block) and verify with `ccc doctor` before indexing.
0 commit comments