Skip to content

Commit a0feb24

Browse files
committed
docs: add README.md
1 parent 1335fd1 commit a0feb24

2 files changed

Lines changed: 57 additions & 0 deletions

File tree

README.md

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

assets/mstudio.png

84.6 KB
Loading

0 commit comments

Comments
 (0)