@neuraparse/synaptik 0.1.0 → 0.1.1
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/README.md +78 -31
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,10 +1,18 @@
|
|
|
1
1
|
# Synaptik
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Synaptik is a multi-provider AI coding CLI built for real terminal workflows.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
It is designed for code understanding, code changes, provider switching, and
|
|
6
|
+
tool-driven development inside an active project workspace.
|
|
7
|
+
|
|
8
|
+
## Availability
|
|
9
|
+
|
|
10
|
+
Synaptik is currently distributed as an npm package.
|
|
11
|
+
|
|
12
|
+
The package is published, but the source code is not currently released as a
|
|
13
|
+
public open-source repository.
|
|
6
14
|
|
|
7
|
-
|
|
15
|
+
## Install
|
|
8
16
|
|
|
9
17
|
```bash
|
|
10
18
|
npm install -g @neuraparse/synaptik
|
|
@@ -12,41 +20,80 @@ npm install -g @neuraparse/synaptik
|
|
|
12
20
|
|
|
13
21
|
This installs the `synaptik` and `syn` commands globally.
|
|
14
22
|
|
|
15
|
-
##
|
|
23
|
+
## What Synaptik Does
|
|
24
|
+
|
|
25
|
+
- Works across multiple AI providers in one coding workflow
|
|
26
|
+
- Lets you move between Claude and OpenAI-backed routes instead of being locked
|
|
27
|
+
to one path
|
|
28
|
+
- Supports provider chains and fallbacks for continuity
|
|
29
|
+
- Understands project context before editing
|
|
30
|
+
- Uses search, read, edit, write, shell, LSP, and MCP-aware workflows
|
|
31
|
+
- Supports project and user skills through `SKILL.md`
|
|
32
|
+
- Focuses on minimal, reviewable file changes instead of noisy rewrites
|
|
33
|
+
|
|
34
|
+
## Provider Support
|
|
35
|
+
|
|
36
|
+
Synaptik supports both account-backed and API-based provider modes.
|
|
16
37
|
|
|
17
|
-
- `
|
|
18
|
-
|
|
19
|
-
- `
|
|
20
|
-
|
|
21
|
-
- `
|
|
22
|
-
|
|
23
|
-
- `
|
|
24
|
-
-
|
|
25
|
-
- `synaptik`
|
|
26
|
-
- `syn`
|
|
38
|
+
- `claude-code`
|
|
39
|
+
Uses the official `claude` CLI for account-backed Claude workflows
|
|
40
|
+
- `codex-cli`
|
|
41
|
+
Uses the official `codex` CLI for account-backed OpenAI workflows
|
|
42
|
+
- `anthropic`
|
|
43
|
+
Uses a direct Anthropic API configuration
|
|
44
|
+
- `openai-compatible`
|
|
45
|
+
Uses OpenAI-style API endpoints and compatible deployments
|
|
27
46
|
|
|
28
|
-
|
|
47
|
+
You can keep a provider chain configured so work can continue through another
|
|
48
|
+
provider path when needed.
|
|
29
49
|
|
|
30
|
-
|
|
31
|
-
- unscoped `synaptik` is already taken on npm
|
|
32
|
-
- `prepublishOnly` runs typecheck, tests, and build before publish
|
|
33
|
-
- package payload is limited to `dist/` and `README.md`
|
|
50
|
+
## Skills
|
|
34
51
|
|
|
35
|
-
|
|
52
|
+
Synaptik supports reusable skills for project-specific or user-specific
|
|
53
|
+
workflow guidance.
|
|
36
54
|
|
|
37
|
-
|
|
55
|
+
- Project skills can live under `.synaptik/skills/**/SKILL.md`
|
|
56
|
+
- User skills can live under `~/.synaptik/skills/**/SKILL.md`
|
|
57
|
+
- Built-in workflow skills help with investigation, editing, and verification
|
|
58
|
+
- Matching skills are injected into the turn context when relevant
|
|
38
59
|
|
|
39
|
-
|
|
60
|
+
## Coding Workflow
|
|
61
|
+
|
|
62
|
+
Synaptik is built for code work, not just chat.
|
|
63
|
+
|
|
64
|
+
- Discover files across the workspace
|
|
65
|
+
- Search code with grep-style matching
|
|
66
|
+
- Read full files or targeted ranges
|
|
67
|
+
- Build context from the current workspace, file mentions, and active skills
|
|
68
|
+
- Apply minimal edits with explicit approval-aware write flow
|
|
69
|
+
- Use shell commands, LSP intelligence, and MCP integrations from the same
|
|
70
|
+
runtime
|
|
71
|
+
|
|
72
|
+
## Editing and Safety
|
|
73
|
+
|
|
74
|
+
- Workspace-aware context assembly
|
|
75
|
+
- Approval-aware editing flow
|
|
76
|
+
- Preview-driven file mutations
|
|
77
|
+
- Minimal edits instead of broad rewrites
|
|
78
|
+
- Provider and tool routing based on request type
|
|
79
|
+
|
|
80
|
+
## Basic Usage
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
synaptik
|
|
84
|
+
synaptik doctor
|
|
85
|
+
synaptik auth status
|
|
86
|
+
synaptik auth login claude-code
|
|
87
|
+
synaptik auth login codex-cli
|
|
88
|
+
synaptik run "inspect the current codebase and summarize the main architecture"
|
|
89
|
+
```
|
|
40
90
|
|
|
41
|
-
|
|
91
|
+
## Configuration
|
|
42
92
|
|
|
43
|
-
- `~/.synaptik
|
|
44
|
-
- `.synaptik
|
|
45
|
-
- `synaptik-mvp` and `synmvp` remain available as aliases
|
|
93
|
+
- Global config path: `~/.synaptik/config.json`
|
|
94
|
+
- Project config path: `.synaptik.json`
|
|
46
95
|
|
|
47
|
-
##
|
|
96
|
+
## Package
|
|
48
97
|
|
|
49
|
-
-
|
|
50
|
-
-
|
|
51
|
-
- `claude-code`: account-backed bridge via official `claude` CLI
|
|
52
|
-
- `codex-cli`: account-backed bridge via official `codex` CLI
|
|
98
|
+
- npm package: `@neuraparse/synaptik`
|
|
99
|
+
- global commands: `synaptik`, `syn`
|