hansjone/netxops
1
0
Fork 0
mirror of https://github.com/hansjone/netxops.git synced 2026-10-09 06:50:46 +08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document GitHub install as the default path.

Browse source 
Path/link installs are developer-only; users should not need link-dsh-peers.

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
oliver 2026-09-04 22:31:10 +08:00
parent 13db99484f
commit 0fcff2d45a
2 changed files with 24 additions and 49 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -23,17 +23,11 @@ Public **DeepSeek Harness** package: host bridge + **Plugins settings card** + o
```powershell
dsh plugin --profile web add github:hansjone/netxops
powershell -File .\scripts\link-preset.ps1
# Then: Settings → Plugins → Netx Ops → paste token + API URL → Save
dsh web
# Settings → Plugins → Netx Ops → token + API URL → Save
```
## Local debug
[examples/local-debug/README.md](examples/local-debug/README.md)
```powershell
bun run bundle # rebuild Plugins card after src/client changes
```
Agent preset (skills): clone once and run `scripts/link-preset.ps1` (or `.sh`).
## Related

61
docs/INSTALL.md
View file

@ -2,45 +2,31 @@
## Prerequisites
1. **DeepSeek Harness** (`dsh`) installed or a local checkout.
1. **DeepSeek Harness** (`dsh`) installed.
2. **netx API** reachable (default `http://127.0.0.1:8890`).
3. **Python 3.11+** on the same machine as `dsh`, with `netx_mcp` importable:
3. **Python 3.11+** with `netx_mcp` importable:
```powershell
pip install "git+https://github.com/hansjone/netx.git#subdirectory=packages/netx-mcp"
python -c "import netx_mcp; print('ok')"
```
You do **not** need OS environment variables for `NETX_API_URL` / `NETX_API_TOKEN`.
No OS env vars needed for URL / token.
## 1) Install host bridge + Plugins settings card
```bash
dsh plugin --profile <name> add github:hansjone/netxops
# or from a checkout:
dsh plugin --profile <name> add /path/to/netxops
```
This mounts `dsh-netxops` (host + browser halves):
- Host: settings namespace **`netxops`**, credential **`NETX_API_TOKEN`**, spawns `mcp__netx__*`
- Browser: **Settings → Plugins → Netx Ops** card (API URL / lang / python + token)
### Fill in the UI (recommended)
1. Open `dsh web` → **Settings** → **Plugins** → **Plugin configuration**
2. Expand **Netx Ops**
3. Paste **API token** (stored as credential `NETX_API_TOKEN`, never in settings JSON)
4. Set **API URL** (e.g. `http://127.0.0.1:8890`), optional lang / python command
5. **Save** — MCP remounts with the new values
### Optional CLI for token only
## Install (GitHub — recommended)
```powershell
powershell -File .\scripts\set-netx-token.ps1 -Token "nxt_…"
dsh plugin --profile web add github:hansjone/netxops
dsh web
```
## 2) Install the agent preset (persona + skills)
Then: **Settings → Plugins → Netx Ops** → paste API token + URL → Save.
That is the whole host install. You do **not** run any `link-dsh-peers` script for GitHub installs.
### Agent preset (persona + skills)
One-time (or after pull):
```powershell
git clone https://github.com/hansjone/netxops.git
@ -50,26 +36,21 @@ powershell -File .\scripts\link-preset.ps1
Unix: `./scripts/link-preset.sh`
Open `dsh web`, new session → preset **Netx Ops**.
New session → preset **Netx Ops**.
## Verify
1. Settings → Plugins shows **Netx Ops** card; token badge becomes “Configured” after save.
2. Tools include `mcp__netx__queryUmeAlarms` (and siblings).
3. “Critical Top by host” / single `host_name` alarm query work.
1. Settings → Plugins shows **Netx Ops**; token badge “Configured” after save.
2. Tools include `mcp__netx__queryUmeAlarms`.
3. Critical Top / single-host alarm queries work.
See [TOOL_MAP.md](TOOL_MAP.md).
## Local `link:` / path install
When you `dsh plugin add D:\path\to\netxops`, pnpm junctions the checkout **outside** the profile tree. Node then resolves imports from that checkout, so DSH peer packages (`@deepseek-ai/schemastery`, …) are invisible unless you link them once:
## Path / local checkout (developers only)
```powershell
powershell -File .\scripts\link-dsh-peers.ps1
dsh plugin --profile web add D:\path\to\netxops
powershell -File .\scripts\link-dsh-peers.ps1 # only for path/link: installs
```
Unix: `./scripts/link-dsh-peers.sh`
(Requires a prior `dsh web` / profile boot so `~/.dsh/profiles/node_modules` exists.)
npm / GitHub installs place the package under the profile `node_modules` and do **not** need this step.
See [examples/local-debug/README.md](../examples/local-debug/README.md).