@hermenics/deepseek-code 0.1.10 → 0.1.12

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.
Files changed (2) hide show
  1. package/README.md +123 -21
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -8,9 +8,10 @@
8
8
  <a href="https://www.npmjs.com/package/@hermenics/deepseek-code"><img src="https://img.shields.io/npm/v/@hermenics/deepseek-code?style=for-the-badge&labelColor=0d1117&color=cyan" alt="npm version" /></a>
9
9
  <img src="https://img.shields.io/badge/model-DeepSeek-4A90D9?style=for-the-badge&labelColor=0d1117" alt="DeepSeek" />
10
10
  <img src="https://img.shields.io/badge/license-Apache--2.0-22c55e?style=for-the-badge&labelColor=0d1117" alt="Apache 2.0" />
11
+ <a href="https://github.com/Hermenics/deepseek-code/actions"><img src="https://img.shields.io/github/actions/workflow/status/Hermenics/deepseek-code/ci.yml?style=for-the-badge&labelColor=0d1117&label=CI" alt="CI" /></a>
11
12
  </p>
12
13
 
13
- <p><strong>A DeepSeek-powered coding assistant that lives in your terminal.</strong></p>
14
+ <p><strong>An open-source, DeepSeek-powered coding assistant that lives in your terminal.</strong></p>
14
15
 
15
16
  </div>
16
17
 
@@ -18,11 +19,22 @@
18
19
 
19
20
  <div align="center">
20
21
  <img src="https://raw.githubusercontent.com/Hermenics/deepseek-code/main/src/public/demo.gif" alt="DeepSeek Code demo" width="80%" />
21
- <br \>
22
- <font color="gray"><sub><i>*Simulated output for demonstration purposes.</i></sub></font>
22
+ <br/>
23
+ <sub><i>Simulated output for demonstration purposes.</i></sub>
23
24
  </div>
24
25
 
25
- ## Get started
26
+ ---
27
+
28
+ ## Features
29
+
30
+ - **Agentic coding** — reads/writes files, runs shell commands, searches code, manages git
31
+ - **Multi-provider** — DeepSeek API, Amazon Bedrock, Google Vertex AI, or any local model (Ollama, LM Studio)
32
+ - **Full TUI** — alternate-screen interface with streamed thinking, rich markdown, and vim mode
33
+ - **Sub-agents** — spawn background agents for parallel tasks
34
+ - **MCP support** — connect to any Model Context Protocol server for extended tooling
35
+ - **Extensible** — slash commands, custom tools, memory, sessions, themes
36
+
37
+ ## Quick start
26
38
 
27
39
  ```bash
28
40
  npm install -g @hermenics/deepseek-code
@@ -30,44 +42,134 @@ npm install -g @hermenics/deepseek-code
30
42
 
31
43
  Then run `deepseek` inside any project. On first run you'll pick a **provider** and configure authentication.
32
44
 
45
+ ### Requirements
46
+
47
+ - Node.js 18+ or [Bun](https://bun.sh) 1.1+
48
+ - A supported LLM provider (see below)
49
+
33
50
  ## Providers & authentication
34
51
 
35
- | Provider | How to authenticate | Env / config keys | |
36
- | --------------------------------| ------------------------------------------------------------------------------| --------------------------------------------------| -----|
37
- | **DeepSeek API** (default) | API key from [platform.deepseek.com](https://platform.deepseek.com/api_keys) | `DEEPSEEK_API_KEY`, `DEEPSEEK_BASE_URL` | |
38
- | **Amazon Bedrock** | AWS IAM credentials via `~/.aws/credentials` | `AWS_REGION`, `AWS_PROFILE` | |
39
- | **Google Vertex AI** | GCP service account JSON key | `GCP_PROJECT`, `GCP_LOCATION`, `GCP_CREDENTIALS` | |
40
- | **Local (Ollama / LM Studio)** | No auth — just point to your local endpoint | `LOCAL_BASE_URL`, `LOCAL_MODEL` |
52
+ | Provider | How to authenticate | Env / config keys |
53
+ |----------|--------------------|--------------------|
54
+ | **DeepSeek API** (default) | API key from [platform.deepseek.com](https://platform.deepseek.com/api_keys) | `DEEPSEEK_API_KEY`, `DEEPSEEK_BASE_URL` |
55
+ | **Amazon Bedrock** | AWS IAM credentials via `~/.aws/credentials` | `AWS_REGION`, `AWS_PROFILE` |
56
+ | **Google Vertex AI** | GCP service account JSON key | `GCP_PROJECT`, `GCP_LOCATION`, `GCP_CREDENTIALS` |
57
+ | **Local (Ollama / LM Studio)** | No auth — point to your local endpoint | `LOCAL_BASE_URL`, `LOCAL_MODEL` |
41
58
 
42
- All config is saved to `~/.deepseek/config.json`. You can also set any config key as an environment variable.
59
+ All config is saved to `~/.deepseek/config.json`. Any config key can also be set as an environment variable.
43
60
 
44
61
  ## Models
45
62
 
46
- Switch between models at any time with `/model`:
63
+ Switch models at any time with `/model`:
47
64
 
48
65
  | Model ID | Description | Context |
49
- |---|---|---|
66
+ |----------|-------------|---------|
50
67
  | `deepseek-v4-flash` | Fast, general purpose (default) | 128K |
51
68
  | `deepseek-v4-pro` | Advanced reasoning | 128K |
52
69
 
53
70
  Each provider also exposes provider-specific models (Bedrock, Vertex, local).
54
71
 
55
- ## What it does
72
+ ## Slash commands
73
+
74
+ | Command | Description |
75
+ |---------|-------------|
76
+ | `/model` | Switch model |
77
+ | `/agent` | Spawn a sub-agent |
78
+ | `/memory` | Manage persistent memory |
79
+ | `/plan` | Enter plan mode |
80
+ | `/review` | Code review |
81
+ | `/vim` | Toggle vim keybindings |
82
+ | `/theme` | Change color theme |
83
+ | `/tools` | List available tools |
84
+ | `/help` | Show all commands |
85
+
86
+ ## Built-in tools
56
87
 
57
- DeepSeek Code is an agentic coding tool with a TUI that lives in your terminal. It understands your codebase and helps you code faster through natural language — reading and writing files, running shell commands, searching code, fetching URLs, managing git, and more.
88
+ The agent has access to these tools out of the box:
89
+
90
+ `ReadFile` · `WriteFile` · `PatchFile` · `Shell` · `Glob` · `Grep` · `Git` · `ReadFolder` · `WebFetch` · `SubAgent` · `Memory` · `Todo` · `Introspect` · `MoA`
58
91
 
59
92
  ## TUI behavior
60
93
 
61
- - Runs on the terminal **alternate screen** so the viewport is clean and scrolling works smoothly without truncation.
62
- - Thinking output is streamed as full multiline blocks and persisted after each response.
63
- - To force main-screen mode (experimental): `OTUI_USE_ALTERNATE_SCREEN=0 deepseek`
94
+ - Runs on the terminal **alternate screen** — clean viewport, smooth scrolling
95
+ - Thinking output is streamed as full multiline blocks and persisted after each response
96
+ - Main-screen mode (experimental): `OTUI_USE_ALTERNATE_SCREEN=0 deepseek`
97
+
98
+ ---
99
+
100
+ ## Development
101
+
102
+ ### Prerequisites
103
+
104
+ - [Bun](https://bun.sh) >= 1.1
105
+ - Node.js >= 18 (for npm publishing)
106
+
107
+ ### Setup
108
+
109
+ ```bash
110
+ git clone https://github.com/Hermenics/deepseek-code.git
111
+ cd deepseek-code
112
+ bun install
113
+ ```
114
+
115
+ ### Commands
116
+
117
+ ```bash
118
+ bun run dev # Start in dev mode (watch)
119
+ bun run start # Run from source
120
+ bun run build # Production build
121
+ bun run typecheck # Type check (tsc --noEmit)
122
+ bun test # Run tests
123
+ ```
124
+
125
+ ### Project structure
126
+
127
+ ```
128
+ src/
129
+ ├── agent/ # Core agent loop, providers (DeepSeek, Bedrock, Vertex)
130
+ ├── commands/ # Slash command definitions
131
+ ├── components/ # Ink/React TUI components
132
+ ├── tools/ # Agent tools (file ops, shell, git, search, etc.)
133
+ ├── context/ # Conversation context management
134
+ ├── hooks/ # Pre/post tool execution hooks
135
+ └── index.tsx # Entry point
136
+ tests/ # Test suite
137
+ ```
138
+
139
+ ---
140
+
141
+ ## Contributing
142
+
143
+ Contributions are welcome! Here's how to get started:
144
+
145
+ 1. **Fork** the repo and create a branch from `main`
146
+ 2. **Install** dependencies with `bun install`
147
+ 3. **Make your changes** — keep files under 500 lines
148
+ 4. **Run checks** before submitting:
149
+ ```bash
150
+ bun run typecheck && bun test
151
+ ```
152
+ 5. **Open a PR** with a clear description of what changed and why
153
+
154
+ ### Guidelines
155
+
156
+ - Follow existing code style (TypeScript, functional where possible)
157
+ - Write tests for new features — tests live in `tests/`, never in `src/`
158
+ - One concern per PR — don't bundle unrelated changes
159
+ - Commit messages should explain the "why", not just the "what"
160
+
161
+ ### Reporting bugs
162
+
163
+ File a [GitHub issue](https://github.com/Hermenics/deepseek-code/issues) with steps to reproduce, or use `/help` inside the TUI.
164
+
165
+ ---
64
166
 
65
- ## Reporting bugs
167
+ ## License
66
168
 
67
- File a [GitHub issue](https://github.com/Hermenics/deepseek-code/issues) or use `/help` inside the TUI.
169
+ [Apache 2.0](./LICENSE)
68
170
 
69
171
  ---
70
172
 
71
173
  <div align="center">
72
- <p>Made with ❤️ by <a href="https://github.com/Hermenics">Hermenics Team</a></p>
174
+ <p>Made with ❤️ by <a href="https://github.com/Hermenics">Hermenics</a></p>
73
175
  </div>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hermenics/deepseek-code",
3
- "version": "0.1.10",
3
+ "version": "0.1.12",
4
4
  "description": "An AI-powered coding assistant that lives in your terminal",
5
5
  "keywords": [
6
6
  "ai",