console-embed / README.md
putkoff
Demo links -> demo.hugpy.ai/station (same-origin, always the current release)
f791ff3
|
Raw History Blame Contribute Delete
2.1 kB
---
title: "@hugpy/console"
emoji: πŸ”Œ
colorFrom: purple
colorTo: indigo
sdk: static
pinned: false
license: other
license_name: hugpy-source-available
license_link: https://github.com/hugpy/hugpy/blob/main/LICENSE
short_description: Embeddable web console β€” mountConsole() + a PTY broker
---
# @hugpy/console β€” the embeddable console πŸ”Œ
A portable **terminal Β· file-browser Β· keeper console** for the web, as one
framework-agnostic module: call `mountConsole()` and the console appears inside
**your** app, backed by a reusable PTY broker.
```bash
npm install @hugpy/console
```
## What it is
- **`mountConsole(el, opts)`** β€” drop the full console into any page or app;
no framework required, works next to React/Vue/vanilla alike.
- **PTY broker** β€” the reusable server half: real terminal sessions over
WebSocket, multiplexed, resumable.
- **The same console the fleet uses** β€” this module powers the terminals and
keeper seats inside hugpy Station, the desktop cockpit
([`@hugpy/station`](https://www.npmjs.com/package/@hugpy/station)).
## The @hugpy scope
[`@hugpy/console`](https://www.npmjs.com/package/@hugpy/console) Β·
[`@hugpy/station`](https://www.npmjs.com/package/@hugpy/station) Β·
[`@hugpy/ui`](https://www.npmjs.com/package/@hugpy/ui) Β·
[`@hugpy/ui-shared`](https://www.npmjs.com/package/@hugpy/ui-shared) Β·
[`@hugpy/agents-ui`](https://www.npmjs.com/package/@hugpy/agents-ui) Β·
[`@hugpy/media-intelligence-ui`](https://www.npmjs.com/package/@hugpy/media-intelligence-ui) Β·
[`@hugpy/video-intelligence-ui`](https://www.npmjs.com/package/@hugpy/video-intelligence-ui) Β·
[`@hugpy/vm-mgr`](https://www.npmjs.com/package/@hugpy/vm-mgr)
## Elsewhere
- πŸš€ [hugpy β€” Start Here](https://huggingface.co/spaces/hugpy-ai/hugpy) Β· 🌐 [hugpy.ai](https://hugpy.ai/) Β· πŸ“¦ [PyPI `hugpy`](https://pypi.org/project/hugpy/)
**Live demo:** [the Station showroom](https://demo.hugpy.ai/station/) β€” tern's keeper seat plays back the agent loop; [video & media demos](https://demo.hugpy.ai/).
*Inference you own.* By [John R. Putkey](https://jrputkey.com).