Your Personal AGI
Project description
MirageML Python Library
The MirageML Python Library provides a convenient interface to run AI in the terminal using your files or web documentation as context.
Installation
This requires Python 3.9 or later. Install the package with:
pip install -U mirageml
Usage
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 │
╰───────────────────────────────────────────────────────────────────────────────────────────╯
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. │
╰───────────────────────────────────────────────────────────────────────────────────────────╯
Contributing
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.
Support
Send an email to support@mirageml.com for support.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mirageml-0.1.45.tar.gz
(22.5 kB
view hashes)
Built Distribution
mirageml-0.1.45-py3-none-any.whl
(29.4 kB
view hashes)
Close
Hashes for mirageml-0.1.45-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b53e8abeb78ce8c3153ae8c0ab817a8b349385330283823b3fc7f4f810885cc3 |
|
MD5 | 2faec321886439f35be0a9c4933fee5b |
|
BLAKE2b-256 | a93d16b692817f378478ff8658047e4caacf22c18c7e8485436658c9a5996ddf |