@dev-symphony/sym 0.1.4 → 0.1.5
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 +10 -15
- package/bin/sym-darwin-amd64 +0 -0
- package/bin/sym-darwin-arm64 +0 -0
- package/bin/sym-linux-amd64 +0 -0
- package/bin/sym-linux-arm64 +0 -0
- package/bin/sym-windows-amd64.exe +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,29 +2,24 @@
|
|
|
2
2
|
|
|
3
3
|
LLM-friendly convention linter for AI coding tools.
|
|
4
4
|
|
|
5
|
-
##
|
|
6
|
-
|
|
7
|
-
### One-line MCP Setup
|
|
8
|
-
|
|
9
|
-
```bash
|
|
10
|
-
claude mcp add symphony npx @dev-symphony/sym@latest mcp
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
### Direct Installation
|
|
5
|
+
## Quick Start
|
|
14
6
|
|
|
15
7
|
```bash
|
|
8
|
+
# 1. Install
|
|
16
9
|
npm install -g @dev-symphony/sym
|
|
10
|
+
|
|
11
|
+
# 2. Initialize (GitHub OAuth login + MCP auto-setup)
|
|
12
|
+
sym login
|
|
13
|
+
sym init
|
|
17
14
|
```
|
|
18
15
|
|
|
19
|
-
|
|
16
|
+
> **Note**: `OPENAI_API_KEY` environment variable is required for LLM-based convention conversion.
|
|
20
17
|
|
|
21
|
-
|
|
18
|
+
## MCP Configuration
|
|
22
19
|
|
|
23
|
-
|
|
20
|
+
MCP is auto-configured during `sym init`.
|
|
24
21
|
|
|
25
|
-
|
|
26
|
-
- Windows: `%APPDATA%/Claude/claude_desktop_config.json`
|
|
27
|
-
- Linux: `~/.config/Claude/claude_desktop_config.json`
|
|
22
|
+
For manual setup:
|
|
28
23
|
|
|
29
24
|
```json
|
|
30
25
|
{
|
package/bin/sym-darwin-amd64
CHANGED
|
Binary file
|
package/bin/sym-darwin-arm64
CHANGED
|
Binary file
|
package/bin/sym-linux-amd64
CHANGED
|
Binary file
|
package/bin/sym-linux-arm64
CHANGED
|
Binary file
|
|
Binary file
|