5a79f1a2eb
Some checks failed
CI — Chrome / Chrome — typecheck, test, build (pull_request) Has been cancelled
CI — CLI / CLI — typecheck, build, smoke (pull_request) Has been cancelled
CI — Website / Website — typecheck, build (pull_request) Has been cancelled
CI — VS Code / VS Code — typecheck, build (pull_request) Has been cancelled
- Implemented SiteHeader and SiteFooter components for consistent navigation and footer across the website. - Created CommunityPage and ContributePage to provide information on community involvement and contribution guidelines. - Developed DocsPage to serve as the main documentation hub, detailing features and installation instructions. - Added HomePage to introduce LexAI and its functionalities, highlighting key features and privacy aspects. - Established links.ts for centralized management of external links used throughout the website. - Configured main.tsx for application entry point with React Router for navigation. - Introduced styles.css for consistent styling across the website. - Set up TypeScript configuration files for improved type checking and development experience. - Configured Vite for building and serving the website.
81 lines
3.1 KiB
Markdown
81 lines
3.1 KiB
Markdown
# LexAI
|
|
|
|
**Bring your own LLM key.** LexAI is an open-source writing (and coding) assistant with **no LexAI backend, no account, and no subscription**. Your text and API key go only to the provider you choose.
|
|
|
|
| Package | What it is | Docs |
|
|
| --- | --- | --- |
|
|
| **[packages/chrome](packages/chrome)** | Chrome MV3 extension — select text on any page → Fix / Rephrase / Shorten / Expand / Explain / Make Prompt | [README](packages/chrome/README.md) · [Chrome Web Store](https://chromewebstore.google.com/detail/bagpcheidbkfgijnnmolnkgagibbjfnk) |
|
|
| **[packages/vscode](packages/vscode)** | VS Code / Cursor extension — writing actions + workspace-aware **Code Assist** | [README](packages/vscode/README.md) · [Marketplace](https://marketplace.visualstudio.com/items?itemName=JuanKibin.lexai-vscode) |
|
|
| **[packages/cli](packages/cli)** | CLI **Prompt Builder** — improve a rough idea into a paste-ready prompt | [README](packages/cli/README.md) |
|
|
| **[packages/website](packages/website)** | Marketing site + docs (features & all packages) | [README](packages/website/README.md) |
|
|
|
|
Shared provider/prompt core: [`src/lib`](src/lib).
|
|
|
|
## Quick start
|
|
|
|
```bash
|
|
# Prerequisites: Node 22+
|
|
git clone https://git.juankibin.space/kibin/LexAI.git
|
|
cd LexAI
|
|
|
|
# Install all packages
|
|
npm run install:all
|
|
|
|
# Chrome extension (dev)
|
|
npm run chrome:dev
|
|
|
|
# VS Code extension
|
|
npm run vscode:build
|
|
# or install: https://marketplace.visualstudio.com/items?itemName=JuanKibin.lexai-vscode
|
|
|
|
# CLI Prompt Builder
|
|
npm run cli:build
|
|
export LEXAI_API_KEY=sk-... # required; PowerShell: $env:LEXAI_API_KEY="sk-..."
|
|
export LEXAI_PROVIDER=openai # optional: openai | anthropic | groq | openrouter
|
|
export LEXAI_MODEL=gpt-4o # optional
|
|
node packages/cli/out/cli.js prompt "add rate limiting to the auth routes"
|
|
|
|
# Website (features + docs)
|
|
npm run website:dev
|
|
```
|
|
|
|
## Repository layout
|
|
|
|
```text
|
|
LexAI/
|
|
├── packages/
|
|
│ ├── chrome/ # Manifest V3 extension (WXT + React)
|
|
│ ├── vscode/ # VS Code / Cursor extension
|
|
│ ├── cli/ # lexai prompt CLI
|
|
│ └── website/ # Marketing site + docs
|
|
├── src/lib/ # Shared providers, actions, types
|
|
├── tests/ # Unit + e2e tests (run via chrome package)
|
|
├── docs/ # Project operating docs (agents / planning)
|
|
└── .gitea/ # CI workflows + issue/PR templates
|
|
```
|
|
|
|
## Supported providers
|
|
|
|
OpenAI · Anthropic · Groq · OpenRouter
|
|
|
|
## Privacy
|
|
|
|
- No LexAI servers and no LexAI telemetry
|
|
- Chrome: key encrypted in `chrome.storage.local`
|
|
- VS Code: key in Secret Storage
|
|
- CLI: key via `LEXAI_API_KEY` only; optional `LEXAI_PROVIDER` / `LEXAI_MODEL` (never put the key in `~/.lexai/config.json`)
|
|
|
|
## Contributing
|
|
|
|
See [CONTRIBUTING.md](CONTRIBUTING.md) and our [Code of Conduct](CODE_OF_CONDUCT.md).
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE) © LexAI contributors
|
|
|
|
## Links
|
|
|
|
- Chrome Web Store: https://chromewebstore.google.com/detail/bagpcheidbkfgijnnmolnkgagibbjfnk
|
|
- VS Code Marketplace: https://marketplace.visualstudio.com/items?itemName=JuanKibin.lexai-vscode
|
|
- Source: https://git.juankibin.space/kibin/LexAI
|