{"_id":"@rmux/sdk","name":"@rmux/sdk","dist-tags":{"latest":"0.6.5"},"versions":{"0.6.5":{"name":"@rmux/sdk","version":"0.6.5","description":"TypeScript SDK for RMUX 0.6.x.","type":"module","license":"MIT OR Apache-2.0","repository":{"type":"git","url":"git+https://github.com/Helvesec/rmux-typescript.git"},"homepage":"https://rmux.io","bugs":{"url":"https://github.com/Helvesec/rmux-typescript/issues"},"keywords":["terminal","multiplexer","rmux","sdk"],"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"main":"./dist/index.js","types":"./dist/index.d.ts","sideEffects":false,"publishConfig":{"access":"public"},"scripts":{"build":"tsc -p tsconfig.json","check":"npm run typecheck && npm test","check:prod":"npm run typecheck && npm run test:prod","prepack":"npm run build","prepublishOnly":"npm run check:prod","test:prod":"npm run build && node test/require-real-rmux.mjs && node --test test/*.test.mjs","typecheck":"tsc --noEmit -p tsconfig.json","test":"npm run build && node --test test/*.test.mjs"},"engines":{"node":">=20"},"dependencies":{"@types/node":"^24.0.0"},"devDependencies":{"typescript":"^5.9.0"},"gitHead":"0193f0e6c6c9582f311ebf54df9f02344a67c7f3","_id":"@rmux/sdk@0.6.5","_nodeVersion":"24.14.0","_npmVersion":"11.9.0","dist":{"integrity":"sha512-ZYhQmZueNo5VOCIcBp97kUFwbgVJ5KJa3CBQuv81NhSWqRWuRCnHECI9j99UOfUWNSmR17ZreQuFx0rEQHOFIg==","shasum":"80ba9663e21c04ae7ba7e359bd66900b8d5013b2","tarball":"https://registry.npmjs.org/@rmux/sdk/-/sdk-0.6.5.tgz","fileCount":48,"unpackedSize":96331,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIHDx2YQcXbeMBPNDChXpyRND8/G0WQi4bQA1M8tGKnpNAiEAyOL92QeCUfGOUzn4KvWXVbCIVhhHBLvd0uYI+Ayzmg0="}]},"_npmUser":{"name":"shideneyu","email":"shideneyu@gmail.com"},"directories":{},"maintainers":[{"name":"shideneyu","email":"shideneyu@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/sdk_0.6.5_1781782534386_0.9889158106434621"},"_hasShrinkwrap":false}},"time":{"created":"2026-06-18T11:35:34.197Z","0.6.5":"2026-06-18T11:35:34.540Z","modified":"2026-06-18T11:35:34.739Z"},"maintainers":[{"name":"shideneyu","email":"shideneyu@gmail.com"}],"description":"TypeScript SDK for RMUX 0.6.x.","homepage":"https://rmux.io","keywords":["terminal","multiplexer","rmux","sdk"],"repository":{"type":"git","url":"git+https://github.com/Helvesec/rmux-typescript.git"},"bugs":{"url":"https://github.com/Helvesec/rmux-typescript/issues"},"license":"MIT OR Apache-2.0","readme":"# @rmux/sdk\n\n`@rmux/sdk` is the TypeScript SDK for [RMUX](https://github.com/Helvesec/rmux).\nIts public handles follow the same vocabulary as the Rust and Python SDKs:\n`RMUX`, `Session`, `Window`, and `Pane`.\n\n[Examples available](https://rmux.io/docs/examples/#/quickstart)\n\n## Installation\n\n```bash\nnpm install @rmux/sdk\n```\n\n`@rmux/sdk` targets RMUX 0.6.x and uses the `rmux` executable. Install the RMUX\nbinary separately and keep it on `PATH`, or pass a specific binary with\n`RMUX.builder().binary(...)`.\n\n```ts\nimport { RMUX } from \"@rmux/sdk\";\n\nconst rmux = new RMUX();\nfor (const session of await rmux.listSessions()) {\n  console.log(session.session_name);\n}\n```\n\n`Rmux` and `Server` remain available as aliases for existing code.\n\n## Endpoint Selection\n\n```ts\nnew RMUX();                               // default rmux endpoint\nnew RMUX({ socketPath: \"/tmp/rmux\" });    // passes -S /tmp/rmux\nnew RMUX({ socketName: \"demo\" });         // passes -L demo\nRMUX.builder().socketName(\"demo\").connectOrStart();\n```\n\n## Common Operations\n\n```ts\nconst session = await rmux.ensureSession(\"demo\");\nconst pane = session.pane(0, 0);\nawait pane.sendText(\"echo hello\\n\");\nawait pane.expectVisibleText().toContain(\"hello\").timeout(5);\nconst text = await pane.captureText();\n```\n\nFor raw commands:\n\n```ts\nconst run = await rmux.cmd(\"rename-window\", \"-t\", \"demo:0\", \"logs\");\nif (run.returnCode !== 0) {\n  throw new Error(run.stderr);\n}\n```\n","readmeFilename":"README.md","_rev":"1-ca39dbd1d6b73b4152a9927ab71bad7d"}