Skip to content

Commit 418540f

Browse files
committed
docs: rebrand to codei, update env vars and docs
- Rename all CODEINDEX_* environment variable prefixes to CODEI_* in .env.example - Add current npm release version to all README files - Fix config storage descriptions, privacy section wording, and add note about both `codei` and `codeindex` command aliases - Update Vietnamese translation to match latest project setup and configuration changes
1 parent b23ce41 commit 418540f

4 files changed

Lines changed: 29 additions & 25 deletions

File tree

.env.example

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
# NVIDIA API
44
NVIDIA_API_KEY=nvapi-xxx
5-
CODEINDEX_BASE_URL=https://integrate.api.nvidia.com/v1
5+
CODEI_BASE_URL=https://integrate.api.nvidia.com/v1
66

7-
# Optional: ghi ro neu muon, neu khong codeindex tu suy ra tu NVIDIA_API_KEY
8-
CODEINDEX_PROVIDER=nvidia
9-
CODEINDEX_MODEL=minimaxai/minimax-m3
7+
# Optional: ghi ro neu muon, neu khong codei tu suy ra tu NVIDIA_API_KEY
8+
CODEI_PROVIDER=nvidia
9+
CODEI_MODEL=minimaxai/minimax-m3
1010

1111
# Optional alternatives
1212
# OPENAI_API_KEY=sk-xxx

README-Vietnamese.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Thay vì dump toàn bộ codebase vào prompt (50k+ tokens), `codei` build một
66

77
> Ghi chú thương hiệu: `codei` là tên mới của `Codeindex`. Chữ `i` mang hai ý nghĩa: `index``intelligent`. Lệnh CLI là `codei`, gói npm để cài CLI là `pnftrading_codei`, còn core/adapters được publish dưới `pnftrading_codei-*`.
88
> npm package: https://www.npmjs.com/package/pnftrading_codei
9+
> Bản npm hiện tại: `pnftrading_codei@0.1.2`
910
1011
Inspired by [PageIndex](https://github.com/VectifyAI/PageIndex), adapted cho codebase TypeScript.
1112

@@ -14,26 +15,24 @@ Inspired by [PageIndex](https://github.com/VectifyAI/PageIndex), adapted cho cod
1415
## Cài đặt nhanh
1516

1617
```bash
17-
# Clone repo
18+
# Cài từ npmjs
19+
npm install -g pnftrading_codei
20+
21+
# Cấu hình API Key toàn cục (CHỈ CẦN LÀM 1 LẦN)
22+
codei setup
23+
```
24+
25+
Gói npm cài cả hai lệnh: `codei``codeindex`.
26+
27+
### Cài từ source để phát triển
28+
29+
```bash
1830
git clone <this-repo>
1931
cd <repo-folder>
20-
21-
# Install dependencies
2232
pnpm install
23-
24-
# Build tất cả packages
2533
pnpm build
26-
27-
# Link CLI toàn cục (dành cho phát triển)
2834
cd packages/cli && pnpm link --global
29-
30-
# Chạy test toàn bộ dự án
3135
pnpm test
32-
pnpm test:watch # Chế độ theo dõi thay đổi
33-
34-
# Cấu hình API Key toàn cục (CHỈ CẦN LÀM 1 LẦN)
35-
codei setup
36-
3736
```
3837

3938
---
@@ -50,7 +49,7 @@ codei setup
5049

5150
Lệnh này sẽ hỏi bạn Provider (OpenAI, Gemini, v.v.), API Key, Model name và Base URL (nếu có).
5251

53-
Thông tin này sẽ được lưu tại `~/.codei/config.json` và áp dụng cho **tất cả** các dự án sau này.
52+
Thông tin runtime sẽ được lưu tại `~/.codei/config.json` `~/.codei/.env`, rồi áp dụng cho **tất cả** các dự án sau này.
5453

5554
### Bước 2 — Khởi tạo dự án (Init project)
5655

@@ -65,14 +64,12 @@ Nhấn **Enter** để xác nhận các giá trị mặc định được lấy
6564

6665
```json
6766
{
68-
"provider": "openai",
69-
"model": "gpt-4o",
7067
"indexDir": ".index"
7168
}
7269
```
7370

7471
> [!TIP]
75-
> Bạn vẫn có thể ghi đè (override) cấu hình toàn cục bằng cách sửa file `.codei.json` dự án hoặc dùng biến môi trường.
72+
> `.codei.json` chỉ dành cho cấu hình local của project như `indexDir`, `projectName`, `summaryMode`, server settings. Provider/model/API key nên để trong `~/.codei/.env`, `.env` của project, biến môi trường, hoặc CLI flags.
7673
7774
**Thứ tự ưu tiên (Priority):**
7875
`Mặc định < Toàn cục (~/.codei) < Dự án (.codei.json) < Biến môi trường (ENV) < CLI flags`
@@ -83,6 +80,7 @@ Nhấn **Enter** để xác nhận các giá trị mặc định được lấy
8380
| `openai` | `OPENAI_API_KEY` | `gpt-4o` |
8481
| `anthropic` | `ANTHROPIC_API_KEY` | `claude-sonnet-4-5` |
8582
| `google` | `GOOGLE_API_KEY` | `gemini-1.5-flash` |
83+
| `nvidia` | `NVIDIA_API_KEY` | `minimaxai/minimax-m3` |
8684
| `custom` | `CUSTOM_API_KEY` | `gpt-4o-compatible` |
8785
| `ollama` | _(không cần)_ | `llama3.2` |
8886

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
77
> Brand note: `codei` is the new product name for `Codeindex`. The `i` stands for both `index` and `intelligent` context retrieval. The CLI command is `codei`, the npm package is `pnftrading_codei`, and the core/adapter packages are published under `pnftrading_codei-*`.
88
> npm package: https://www.npmjs.com/package/pnftrading_codei
9+
> Current npm release: `pnftrading_codei@0.1.2`
910
1011
![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)
1112
![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=flat\&logo=typescript\&logoColor=white)
@@ -50,7 +51,7 @@ After: Paste 3 files (2KB) → Same answer
5051
| **Setup** | 2 minutes | 30 minutes | 0 |
5152
| **Accuracy** | LLM reasoning | Cosine similarity | You're guessing |
5253
| **Updates** | Instant | Re-embed entire codebase | Manual |
53-
| **Privacy** | 100% local | Data leaves machine | You're in control |
54+
| **Privacy** | Local index; provider call only when configured | Data leaves machine | You choose what to paste |
5455
| **Cost** | Free (MIT) | $20-100/month | Free (wasteful) |
5556

5657
***
@@ -84,6 +85,8 @@ codei index .
8485
codei query "How does the auth module work?"
8586
```
8687

88+
The npm package installs both command aliases: `codei` and `codeindex`.
89+
8790
Global setup is stored under `~/.codei/` and reused for all future projects.
8891

8992
If you prefer env-based global runtime config, `codei setup` also writes `~/.codei/.env`.
@@ -212,7 +215,7 @@ codei/
212215
└── docs/ # Documentation
213216
```
214217

215-
**No external dependencies.** Everything runs locally.
218+
The index and HTTP server run locally. By default, semantic summaries and query reasoning use your configured LLM provider; use `ollama` for a fully local model path.
216219

217220
***
218221

packages/cli/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
77
> Brand note: the product and CLI are now called `codei`. The `i` stands for both `index` and `intelligent` context retrieval. The published CLI package is `pnftrading_codei`, while the core and adapter packages are published under `pnftrading_codei-*`.
88
> npm package: https://www.npmjs.com/package/pnftrading_codei
9+
> Current npm release: `pnftrading_codei@0.1.2`
910
1011
## Quick Start
1112

@@ -24,6 +25,8 @@ codei index .
2425
codei query "How does authentication work?"
2526
```
2627

28+
The package installs both command aliases: `codei` and `codeindex`.
29+
2730
## Commands
2831

2932
| Command | Description |
@@ -45,7 +48,7 @@ CODEI_MODEL=minimaxai/minimax-m3
4548
CODEI_BASE_URL=https://integrate.api.nvidia.com/v1
4649
```
4750

48-
`codei setup` writes global config to `~/.codei/config.json` and `~/.codei/.env`, so in most cases you only need to configure it once.
51+
`codei setup` writes global config to `~/.codei/config.json` and runtime env to `~/.codei/.env`, so in most cases you only need to configure it once.
4952

5053
## Features
5154

0 commit comments

Comments
 (0)