@sonnechasser/ntrp 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 +116 -0
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +12 -4
package/README.md
ADDED
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
# NTRP
|
|
2
|
+
|
|
3
|
+
GTM health diagnostic CLI — listen to your pipeline, report what you hear.
|
|
4
|
+
|
|
5
|
+
NTRP sits on top of your CRM exports and activity data, computes five vital signs (freshness, flow rate, drop rate, signal-to-noise, thread depth), and helps you investigate issues in plain English.
|
|
6
|
+
|
|
7
|
+
## Requirements
|
|
8
|
+
|
|
9
|
+
- **Node.js 22+**
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install -g @sonnechasser/ntrp
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Verify:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
ntrp setup check
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Activate your license
|
|
24
|
+
|
|
25
|
+
Most commands require a license key.
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
ntrp activate NTRP-XXXX-XXXX-XXXX
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
In the interactive REPL, use `/activate NTRP-XXXX-XXXX-XXXX`.
|
|
32
|
+
|
|
33
|
+
Purchase a license at [ntrp.sonnechasser.com](https://ntrp.sonnechasser.com).
|
|
34
|
+
|
|
35
|
+
## Quick start
|
|
36
|
+
|
|
37
|
+
Launch the conversational REPL:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
ntrp
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
On first run, complete `/onboard` to set up your company profile, or load sample data:
|
|
44
|
+
|
|
45
|
+
- Type `use demo data` in the REPL, or
|
|
46
|
+
- Run `ntrp demo --scenario hidden_crisis --no-profile`
|
|
47
|
+
|
|
48
|
+
Then ask questions naturally — e.g. *"is our pipeline healthy?"* or *"what's stuck?"*
|
|
49
|
+
|
|
50
|
+
## Setup check
|
|
51
|
+
|
|
52
|
+
See license, profile, LLM keys, and local paths:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
ntrp setup check
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Headless / JSON output:
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
ntrp setup check --json
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Common commands
|
|
65
|
+
|
|
66
|
+
| Command | Description |
|
|
67
|
+
|---------|-------------|
|
|
68
|
+
| `ntrp` | Open the interactive REPL |
|
|
69
|
+
| `/home` | Status dashboard |
|
|
70
|
+
| `/onboard` | Company profile wizard |
|
|
71
|
+
| `/demo` | Load demo scenario data |
|
|
72
|
+
| `/handoff` | Export or agent prompts |
|
|
73
|
+
| `/update` | Upgrade to the latest version |
|
|
74
|
+
| `ntrp setup check` | Validate local configuration |
|
|
75
|
+
|
|
76
|
+
Type `/help` inside the REPL for shortcuts.
|
|
77
|
+
|
|
78
|
+
## AI features (optional)
|
|
79
|
+
|
|
80
|
+
For AI-powered findings and `/ask`, store API keys in `~/.ntrp/config.json`:
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
ntrp config set api-key <anthropic-key>
|
|
84
|
+
ntrp config set openai-api-key <openai-key>
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Core vital-sign computation works without AI keys.
|
|
88
|
+
|
|
89
|
+
## Update
|
|
90
|
+
|
|
91
|
+
Inside the REPL:
|
|
92
|
+
|
|
93
|
+
```
|
|
94
|
+
/update
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
Or reinstall:
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
npm install -g @sonnechasser/ntrp
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
## Data & config
|
|
104
|
+
|
|
105
|
+
Local state lives in `~/.ntrp/` (config, sessions, DuckDB datasets). Override with `NTRP_HOME` if needed.
|
|
106
|
+
|
|
107
|
+
## Links
|
|
108
|
+
|
|
109
|
+
- **Website:** [ntrp.sonnechasser.com](https://ntrp.sonnechasser.com)
|
|
110
|
+
- **npm:** [@sonnechasser/ntrp](https://www.npmjs.com/package/@sonnechasser/ntrp)
|
|
111
|
+
- **Repository:** [github.com/sonnechasser/ntrp-cli-v2](https://github.com/sonnechasser/ntrp-cli-v2)
|
|
112
|
+
- **Issues:** [GitHub Issues](https://github.com/sonnechasser/ntrp-cli-v2/issues)
|
|
113
|
+
|
|
114
|
+
## License
|
|
115
|
+
|
|
116
|
+
Commercial software — requires a license key. See [ntrp.sonnechasser.com](https://ntrp.sonnechasser.com).
|
package/dist/index.js
CHANGED
|
@@ -23623,7 +23623,7 @@ async function main() {
|
|
|
23623
23623
|
}
|
|
23624
23624
|
console.error(chalk62.red(`
|
|
23625
23625
|
${lic.message}`));
|
|
23626
|
-
console.error(chalk62.dim(" Purchase a license at https://ntrp.
|
|
23626
|
+
console.error(chalk62.dim(" Purchase a license at https://ntrp.sonnechasser.com\n"));
|
|
23627
23627
|
process.exit(1);
|
|
23628
23628
|
}
|
|
23629
23629
|
}
|