Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KishoreMayank authored Nov 7, 2023
1 parent ddd1044 commit a15074c
Showing 1 changed file with 39 additions and 34 deletions.
73 changes: 39 additions & 34 deletions README.md
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

0 comments on commit a15074c

Please sign in to comment.