vivekmind 0.15.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,203 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2025 Google LLC
191
+ Copyright 2025 Qwen
192
+
193
+ Licensed under the Apache License, Version 2.0 (the "License");
194
+ you may not use this file except in compliance with the License.
195
+ You may obtain a copy of the License at
196
+
197
+ http://www.apache.org/licenses/LICENSE-2.0
198
+
199
+ Unless required by applicable law or agreed to in writing, software
200
+ distributed under the License is distributed on an "AS IS" BASIS,
201
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202
+ See the License for the specific language governing permissions and
203
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,386 @@
1
+ <p align="center">
2
+ <img src="https://vivekmind.com/favicon.ico" alt="VivekMind" width="64" height="64" />
3
+ </p>
4
+
5
+ <h1 align="center">VivekMind CLI</h1>
6
+
7
+ <p align="center">
8
+ <strong>Open-source terminal AI coding agent with full AWS Bedrock support</strong>
9
+ </p>
10
+
11
+ <p align="center">
12
+ <a href="https://github.com/Lnxtanx/vivekmind-cli/releases"><img src="https://img.shields.io/npm/v/vivekmind?style=flat-square" alt="npm" /></a>
13
+ <a href="https://github.com/Lnxtanx/vivekmind-cli/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/vivekmind?style=flat-square" alt="license" /></a>
14
+ <a href="https://github.com/Lnxtanx/vivekmind-cli"><img src="https://img.shields.io/node/v/vivekmind?style=flat-square" alt="node" /></a>
15
+ </p>
16
+
17
+ ---
18
+
19
+ VivekMind is a fork of [Qwen Code](https://github.com/QwenLM/qwen-code) (by Google & Alibaba Cloud), tailored for developers who want a powerful, provider-flexible AI coding assistant that lives entirely inside the terminal. It ships with native AWS Bedrock integration, 20+ AI provider support, and a rich extensible architecture built around tools, skills, agents, and MCP servers.
20
+
21
+ Install it, point it at any model, and start coding — all from your shell.
22
+
23
+ ---
24
+
25
+ ## Quick Start
26
+
27
+ ```bash
28
+ # Install globally
29
+ npm install -g vivekmind
30
+
31
+ # Launch interactive mode
32
+ vivekmind
33
+
34
+ # Or use the short alias
35
+ vm
36
+
37
+ # One-shot prompt
38
+ vivekmind -p "explain this repository"
39
+ ```
40
+
41
+ Requires **Node.js >= 20**.
42
+
43
+ ---
44
+
45
+ ## AI Providers (20+)
46
+
47
+ VivekMind supports a wide range of AI providers out of the box. Set the corresponding environment variable and configure in `~/.vivekmind/settings.json`.
48
+
49
+ | Provider | Auth Type | Example Models |
50
+ |----------|-----------|----------------|
51
+ | **AWS Bedrock** | `bedrock` | Claude Opus 4.7, Amazon Nova Pro, Llama 4 Maverick |
52
+ | **Anthropic** | `anthropic` | Claude Opus 4.7, Sonnet 4.6, Haiku 4.5 |
53
+ | **Google Gemini** | `gemini` | Gemini 3 Pro, 2.5 Pro, 2.5 Flash |
54
+ | **OpenAI** | `openai` | GPT-5.2, 5.4 Mini, 4.1, o3, o4-mini |
55
+ | **Azure OpenAI** | `azure-openai` | GPT-5.2 (Azure) |
56
+ | **Anthropic (Vertex AI)** | `anthropic-vertex-ai` | Claude Opus 4.7 (Vertex) |
57
+ | **DeepSeek** | `deepseek` | DeepSeek Chat V3, DeepSeek Reasoner R1 |
58
+ | **Mistral AI** | `mistral` | Mistral Large, Codestral, Pixtral Large |
59
+ | **Alibaba DashScope** | `dashscope` | Qwen3 Coder Plus, Qwen VL Max |
60
+ | **xAI (Grok)** | `xai` | Grok 4 |
61
+ | **OpenRouter** | `openrouter` | Claude Opus 4.7 (OpenRouter) |
62
+ | **Groq** | `groq` | Llama 3.3 70B (Groq) |
63
+ | **Together AI** | `together` | Llama 3.3 70B (Together) |
64
+ | **Fireworks AI** | `fireworks` | Llama 4 Maverick (Fireworks) |
65
+ | **Cohere** | `cohere` | Command R+ |
66
+ | **Perplexity** | `perplexity` | Sonar Pro |
67
+ | **SiliconFlow** | `siliconflow` | DeepSeek V3 (SiliconFlow) |
68
+ | **Hugging Face** | `huggingface` | Llama 3.3 70B (HF) |
69
+ | **IBM Watsonx** | `watsonx` | Llama 4 Maverick (Watsonx) |
70
+ | **Novita AI** | `novita` | Llama 3.1 70B (Novita) |
71
+ | **Ollama** | `ollama` | Any local model (localhost:11434) |
72
+ | **LM Studio** | `lm-studio` | Any loaded model (localhost:1234) |
73
+
74
+ ### AWS Bedrock Setup
75
+
76
+ AWS Bedrock works with your existing AWS credentials. No additional API key is needed:
77
+
78
+ ```bash
79
+ # Ensure AWS credentials are set
80
+ export AWS_REGION=us-east-1
81
+ export AWS_ACCESS_KEY_ID=your-key
82
+ export AWS_SECRET_ACCESS_KEY=your-secret
83
+
84
+ # Start VivekMind
85
+ vivekmind
86
+ ```
87
+
88
+ Bedrock models are auto-discovered via `ListFoundationModels` API. Configure specific models in `settings.json`:
89
+
90
+ ```json
91
+ {
92
+ "modelProviders": {
93
+ "bedrock": [
94
+ {
95
+ "id": "anthropic.claude-opus-4-7",
96
+ "name": "Claude Opus 4.7 (Bedrock)",
97
+ "capabilities": { "vision": true },
98
+ "generationConfig": { "contextWindowSize": 1000000 }
99
+ },
100
+ {
101
+ "id": "amazon.nova-pro-v1",
102
+ "name": "Amazon Nova Pro",
103
+ "capabilities": { "vision": true },
104
+ "generationConfig": { "contextWindowSize": 1000000 }
105
+ }
106
+ ]
107
+ }
108
+ }
109
+ ```
110
+
111
+ ---
112
+
113
+ ## Features
114
+
115
+ ### Built-in Tools
116
+
117
+ VivekMind gives the AI agent direct access to powerful tools for real coding workflows:
118
+
119
+ | Tool | Description |
120
+ |------|-------------|
121
+ | `Edit` | Search-and-replace file editing |
122
+ | `WriteFile` | Create or overwrite files |
123
+ | `ReadFile` | Read file contents |
124
+ | `Grep` | Regex search across files (bundled ripgrep) |
125
+ | `Glob` | Find files by pattern |
126
+ | `Shell` | Execute shell commands |
127
+ | `TodoWrite` | Track and manage task progress |
128
+ | `Agent` | Spawn subagents for complex multi-step tasks |
129
+ | `WebFetch` | Fetch and read web pages |
130
+ | `Lsp` | Language Server Protocol integration |
131
+ | `SaveMemory` | Save information to project memory |
132
+ | `CronCreate/CronList/CronDelete` | Schedule and manage tasks |
133
+ | `SendMessage` | Send messages via channel integrations |
134
+ | `Monitor` | Watch files and processes for changes |
135
+
136
+ Plus any tools discovered from connected **MCP servers**.
137
+
138
+ ### Slash Commands
139
+
140
+ Over 40 built-in commands for session control, configuration, and workflow management:
141
+
142
+ ```
143
+ /model Switch AI model
144
+ /compress Compress chat history to save context
145
+ /clear Clear conversation
146
+ /memory Open memory manager
147
+ /remember Save info to memory
148
+ /forget Remove info from memory
149
+ /skills List available skills
150
+ /tools List available tools
151
+ /mcp Manage MCP servers
152
+ /agents Manage subagents
153
+ /arena Compare models head-to-head
154
+ /export Export conversation (HTML, Markdown, JSON)
155
+ /resume Resume a previous session
156
+ /rewind Rewind to a previous state
157
+ /plan Enter planning mode
158
+ /hooks Manage pre/post tool execution hooks
159
+ /settings Open settings dialog
160
+ /theme Change terminal theme
161
+ /vim Toggle vim mode
162
+ /init Initialize project configuration
163
+ /doctor Run diagnostic checks
164
+ /channel Manage messaging channels (start, stop, status, list, configure-telegram)
165
+ ```
166
+
167
+ Create custom slash commands by adding `.md` files to `.vivekmind/commands/`.
168
+
169
+ ### Memory System
170
+
171
+ VivekMind remembers your project context automatically:
172
+
173
+ - **Auto-extraction** — Key facts are extracted from every conversation turn
174
+ - **Dream consolidation** — Periodically merges and deduplicates memory entries
175
+ - **Relevance recall** — Relevant memories are injected into future prompts
176
+ - **Manual control** — Use `/remember`, `/forget`, `/memory`, and `/dream` to manage memories
177
+ - **Per-project storage** — Memories live in `~/.vivekmind/auto-memory/` by project
178
+
179
+ ### Subagents
180
+
181
+ Break complex tasks into parallel, focused workflows:
182
+
183
+ - Built-in agents: `general-purpose`, `Explore` (read-only exploration)
184
+ - Define custom agents as `.md` files in `.vivekmind/agents/`
185
+ - Configure tool subsets, model preferences, and generation methods
186
+ - Run in tmux, iTerm, or in-process
187
+ - Supports background tasks with notifications
188
+
189
+ ### Skills System
190
+
191
+ Layer reusable knowledge and automation on top of the base agent:
192
+
193
+ - **4 skill levels**: project > user > extension > bundled (precedence order)
194
+ - **Conditional activation** — Skills trigger based on file path patterns
195
+ - **Hooks** — Define pre/post execution hooks (shell commands or HTTP calls)
196
+ - **Live reload** — File watcher auto-refreshes skill cache on changes
197
+ - Place skills in `.vivekmind/skills/` with `SKILL.md` files
198
+
199
+ ### MCP (Model Context Protocol)
200
+
201
+ Connect to any MCP-compatible server to extend tool capabilities:
202
+
203
+ - Full MCP client via `@modelcontextprotocol/sdk`
204
+ - Discover tools, prompts, and resources dynamically
205
+ - OAuth support with Google Auth and service account impersonation
206
+ - Add servers via `/mcp` command or `settings.json`
207
+ - Tools from MCP servers appear alongside built-in tools
208
+
209
+ ### Channel Integrations
210
+
211
+ Connect VivekMind to messaging platforms as a bot:
212
+
213
+ ```bash
214
+ # Interactive Telegram setup
215
+ vivekmind channel configure-telegram
216
+
217
+ # Start a channel
218
+ vivekmind channel start my-telegram
219
+ ```
220
+
221
+ #### Supported Channels
222
+
223
+ | Channel | Status | Description |
224
+ |---------|--------|-------------|
225
+ | **Telegram** | **Full support (grammY)** | High-fidelity integration with interactive tool approvals, multi-choice question prompts, and real-time SSE progress reporting. |
226
+ | **WeChat / Weixin** | Adapter available | Standard chat adapter. |
227
+ | **DingTalk** | Adapter available | Standard chat adapter. |
228
+ | **Custom** | Plugin framework | Build your own channel via `@vivekmind/channel-base`. |
229
+
230
+ #### Telegram Channel Features
231
+
232
+ VivekMind provides an industry-leading user experience for Telegram users:
233
+ - **Interactive Tool Confirmation:** Confirm tool calls (such as writes or executing commands) directly inside your Telegram chat using inline approval buttons (**Allow Once**, **Always Allow**, **Deny**).
234
+ - **Interactive Question Prompts:** Responds to multi-choice prompts (like `askUserQuestion`) using numbered interactive buttons.
235
+ - **Real-Time Tool Status Display:** Follows the agent's work step-by-step:
236
+ - Prints a dynamic `> Thinking...` card on start.
237
+ - Lists each tool on its own line: ` {toolIcon} [tool_name] status` using text labels instead of emojis (e.g. `🔍 [read_file] completed`, `✏️ [write_file] in progress`).
238
+ - Limits output to max 8 lines, truncating and grouping older steps as ` +N more`.
239
+ - Appends a status footer showing completed vs active tool counts and elapsed execution seconds: ` N tools done, M active, Xs`.
240
+ - Updates the card to `> Done — X tools completed in Ys` upon execution completion and deletes itself after 5 seconds to keep the chat clean (or instantly clears the card when text response streaming begins).
241
+
242
+ Channel configuration lives in `settings.json` under the `channels` key. See `settings.example.json` for templates.
243
+
244
+ ### Non-Interactive / Headless Mode
245
+
246
+ Integrate VivekMind into scripts and CI pipelines:
247
+
248
+ ```bash
249
+ # One-shot prompt with text output
250
+ vivekmind -p "fix the bug in auth.ts"
251
+
252
+ # JSON output for programmatic use
253
+ vivekmind -p "list all TODOs" --output json
254
+
255
+ # Stream JSON for real-time processing
256
+ vivekmind -p "refactor module" --output stream-json
257
+ ```
258
+
259
+ ### Additional Features
260
+
261
+ - **Sandbox** — Docker and Podman sandbox support for safe code execution
262
+ - **LSP Integration** — Language Server Protocol for code intelligence
263
+ - **Extensions** — Install community extensions from GitHub or npm
264
+ - **i18n** — English, Chinese (zh, zh-TW), Japanese, German, French, Russian, Portuguese, Catalan
265
+ - **Themes** — 15+ built-in terminal themes (dark, light, dracula, github, ayu, etc.)
266
+ - **Vim Mode** — Full vim keybinding support
267
+ - **Session Management** — Resume, rewind, rename, export, and delete sessions
268
+ - **Hooks** — Pre/post tool execution hooks (shell commands and HTTP)
269
+ - **Git Integration** — Branch detection, PR review, presubmit checks
270
+ - **Syntax Highlighting** — Tree-sitter powered with WASM
271
+ - **Cron Jobs** — Schedule recurring tasks from within the CLI
272
+ - **Arena Mode** — Compare models head-to-head on the same task
273
+
274
+ ---
275
+
276
+ ## Configuration
277
+
278
+ ### Settings
279
+
280
+ User settings live in `~/.vivekmind/settings.json`. Copy from the template:
281
+
282
+ ```bash
283
+ cp settings.example.json ~/.vivekmind/settings.json
284
+ ```
285
+
286
+ Or run VivekMind and it will auto-create the file on first run.
287
+
288
+ **Security**: Never put real API keys in `settings.json`. Use the `envKey` field to reference environment variables.
289
+
290
+ ### Project Configuration
291
+
292
+ The `.vivekmind/` directory in your project root holds:
293
+
294
+ ```
295
+ .vivekmind/
296
+ commands/ Custom slash commands (.md files)
297
+ skills/ Custom skills (SKILL.md files)
298
+ agents/ Custom subagents (.md files)
299
+ VIVEKMIND.md Project rules and context (always loaded)
300
+ ```
301
+
302
+ Use `.vivekmindignore` to exclude files from VivekMind's attention.
303
+
304
+ ### Environment Variables
305
+
306
+ Reference API keys via environment variables in `settings.json`:
307
+
308
+ ```bash
309
+ export OPENAI_API_KEY=sk-...
310
+ export ANTHROPIC_API_KEY=sk-ant-...
311
+ export GEMINI_API_KEY=...
312
+ export DEEPSEEK_API_KEY=...
313
+ export DASHSCOPE_API_KEY=...
314
+ export MISTRAL_API_KEY=...
315
+ # etc.
316
+ ```
317
+
318
+ For AWS Bedrock, use standard AWS credentials:
319
+
320
+ ```bash
321
+ export AWS_REGION=us-east-1
322
+ export AWS_ACCESS_KEY_ID=...
323
+ export AWS_SECRET_ACCESS_KEY=...
324
+ ```
325
+
326
+ ---
327
+
328
+ ## Project Structure
329
+
330
+ ```
331
+ vivekmind-cli/
332
+ packages/
333
+ cli/ Main CLI application (React + Ink terminal UI)
334
+ core/ Core agent logic, providers, tools, memory, MCP
335
+ web-templates/ HTML/CSS templates for export and reports
336
+ channels/
337
+ base/ Channel framework (ACP bridge, session router)
338
+ telegram/ Telegram bot adapter
339
+ weixin/ WeChat adapter
340
+ dingtalk/ DingTalk adapter
341
+ plugin-example/ Reference channel plugin
342
+ settings.example.json Full configuration template
343
+ scripts/ Build, test, and development scripts
344
+ ```
345
+
346
+ ---
347
+
348
+ ## Development
349
+
350
+ ```bash
351
+ # Clone the repo
352
+ git clone https://github.com/Lnxtanx/vivekmind-cli.git
353
+ cd vivekmind-cli
354
+
355
+ # Install dependencies
356
+ npm ci
357
+
358
+ # Start in development mode
359
+ npm run dev
360
+
361
+ # Run tests
362
+ npm test
363
+
364
+ # Build
365
+ npm run build
366
+
367
+ # Lint
368
+ npm run lint
369
+
370
+ # Full preflight check
371
+ npm run preflight
372
+ ```
373
+
374
+ ---
375
+
376
+ ## Attribution
377
+
378
+ VivekMind is a fork of [Qwen Code](https://github.com/QwenLM/qwen-code), originally developed by Google LLC and Alibaba Cloud.
379
+
380
+ Qwen Code is copyright (C) 2025 Google LLC and Alibaba Cloud, and is used under the Apache License, Version 2.0.
381
+
382
+ VivekMind modifications are copyright (C) 2026 [VivekMind](https://vivekmind.com).
383
+
384
+ ## License
385
+
386
+ This project is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).