|
| 1 | +# MSTUDIO CLI |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +Missing Studio's AI assistant for interacting with Model Context Protocol (MCP) servers. It provides a friendly, interactive terminal UI to get started quickly. |
| 6 | + |
| 7 | +- Node.js: >= 18 |
| 8 | +- Binaries: `missingstudio` (primary), `mstudio` (alias) |
| 9 | + |
| 10 | +## Install |
| 11 | + |
| 12 | +- npm: `npm i -g @missingstudio/cli` |
| 13 | +- pnpm: `pnpm add -g @missingstudio/cli` |
| 14 | +- yarn: `yarn global add @missingstudio/cli` |
| 15 | + |
| 16 | +## Usage |
| 17 | + |
| 18 | +Run without arguments to launch the interactive UI: |
| 19 | + |
| 20 | +```bash |
| 21 | +mstudio |
| 22 | +``` |
| 23 | + |
| 24 | +Common options: |
| 25 | + |
| 26 | +- `-V, --version`: Output the version number |
| 27 | +- `-h, --help`: Show help information |
| 28 | +- `-v, --verbose`: Enable verbose logging |
| 29 | + |
| 30 | +You can also invoke via the alias: |
| 31 | + |
| 32 | +```bash |
| 33 | +missingstudio OR |
| 34 | +npx @missingstudio/cli |
| 35 | +``` |
| 36 | + |
| 37 | +## Development |
| 38 | + |
| 39 | +- Install deps: `npm install` |
| 40 | +- Start in dev (watch): `npm run dev` |
| 41 | +- Build: `npm run build` |
| 42 | +- Start from build: `npm start` |
| 43 | +- Typecheck: `npm run typecheck` |
| 44 | +- Tests: `npm test` (watch: `npm run test:watch`) |
| 45 | +- Lint/format: `npm run format` (fix: `npm run format:fix`) |
| 46 | + |
| 47 | +## Links |
| 48 | + |
| 49 | +- Website: https://www.missing.studio |
| 50 | +- Repository: https://github.com/missingstudio/cli |
| 51 | +- Issues: https://github.com/missingstudio/cli/issues |
| 52 | + |
| 53 | +## Changelog |
| 54 | + |
| 55 | +See `CHANGELOG.md` for release history. |
| 56 | + |
| 57 | +## License |
| 58 | + |
| 59 | +MIT © Missing Studio. See `LICENSE` for details. |
0 commit comments