The MirageML Python Library provides a convenient interface to run AI in the terminal using your files or web documentation as context.
This requires Python 3.9 or later. Install the package with:
pip install -U mirageml
You can run mirage tutorial to get started with MirageML. This will walk you through the process of creating a source, adding files to it, and using it to chat with MirageML.
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 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 │
╰──────────────────────────────────────────────────────────────────────────────╯
mirage chat [OPTIONS]
╭─ 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. │
╰──────────────────────────────────────────────────────────────────────────────╯
If you want to contribute to MirageML, follow these steps:
- Fork the repository: Click on the 'Fork' button at the top right corner of the repository page on GitHub.
- Clone the forked repository to your local machine.
git clone https://github.com/<user_name>/mirageml_pip.git - Create a new branch for your changes:
git checkout -b <user_name>/your-branch-name - Review the CONTRIBUTING.md file for details on installing pip pacakages, testing, and linting.
- Make your changes in this branch.
- Commit your changes:
git commit -m "Your commit message" - Push your changes to your forked repository:
git push origin your-branch-name - Create a Pull Request: Go to your forked repository on GitHub and click on 'New Pull Request'.
Please provide a clear and concise description of your changes in the pull request description.
Send an email to support@mirageml.com for support.