Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #73

Merged
merged 2 commits into from
Nov 7, 2023
Merged

Update README.md #73

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a15074c
Update README.md
KishoreMayank Nov 7, 2023
fda8cc7
Bump the build number
KishoreMayank Nov 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 39 additions & 34 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,47 +19,52 @@ You can use 'mirageml', 'mirage', or 'mml' to call the package.
mirage [OPTIONS] COMMAND [ARGS]
```
```
╭─ Options ─────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰───────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ────────────────────────────────────────────────────────────────────────────────╮
│ chat Chat with MirageML │
│ login Login to MirageML │
╰───────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Manage Source ───────────────────────────────────────────────────────────────────────────╮
│ add Add a new source │
│ delete Delete sources │
│ list List sources │
│ sync Sync sources │
╰───────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Utils and Configs ───────────────────────────────────────────────────────────────────────╮
│ config Manage the config │
╰───────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ chat Chat with MirageML │
│ login Login to Mirage ML │
│ tutorial Walk through the basics of using mirageml │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Manage Resources ───────────────────────────────────────────────────────────╮
│ add Add a new resource │
│ delete Delete resources │
│ list List resources │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Utils and Configs ──────────────────────────────────────────────────────────╮
│ config Manage the config │
╰──────────────────────────────────────────────────────────────────────────────╯
```

## Chat Commands
```
mirage chat [OPTIONS]
```
```
╭─ Options ─────────────────────────────────────────────────────────────────────────────────╮
│ --files -f TEXT Path to files/directories to use as context. │
│ │
│ mirage chat -f {filepath} │
│ [default: None] │
│ --urls -u TEXT URLs to use as context. │
│ │
│ mirage chat -u {url} │
│ [default: None] │
│ --sources -s TEXT Specify sources to use as context: │
│ │
│ Ex: mirage chat -s disney-robot │
│ │
│ Sources: │
│ │
│ • disney-robot │
│ --help Show this message and exit. │
╰───────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --files -f TEXT Path to files/directories to use as context. │
│ │
│ mml chat -f {filepath} -f {directory} │
│ [default: None] │
│ --urls -u TEXT URLs to use as context. │
│ │
│ mml chat -u {url1} -u {url2} │
│ [default: None] │
│ --sources -s TEXT Specify sources: │
│ │
│ Ex: mml chat -s modal -s electronjs │
│ │
│ Sources: │
│ │
│ • modal │
│ • electronjs │
│ • notion │
│ [default: None] │
│ --system-prompt -sp TEXT Name of the system prompt to use │
│ [default: None] │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
```

## Contributing
Expand Down