Run and expand your personal AI tools
Project description
AIConsole
Your AI tools that run on your own device
Build and train AI personal assistants that can run code locally to perform any tasks.
AI Console is an AI-powered personal assistant designed to help you with a wide range of tasks. It combines the power of artificial intelligence and natural language processing to provide personalized assistance and streamline your workflows.
Features
Task Management: AI Console can help you manage your tasks and projects efficiently. It can create, update, and track your to-do lists, set reminders, and provide helpful prompts to keep you on track.
Programming Assistance: Whether you're a beginner or an experienced developer, AI Console can assist you in coding tasks. It can generate code snippets, fix common programming errors, and provide recommendations for improving your code.
Content Creation: Need help with content creation? AI Console has got you covered. It can generate engaging blog post ideas, suggest catchy headlines, and even assist in crafting compelling introductions. With its imaginative voice and storytelling techniques, AI Console can elevate your content creation efforts.
Data Retrieval: Say goodbye to tedious manual data retrieval tasks. AI Console can fetch data from various sources, such as APIs, databases, and web scraping. It can organize and analyze the retrieved data, and present it in a format that suits your needs.
Installing & Running
pip install --upgrade aiconsole --pre # (in some environments it must be pip3 instead of pip)
mkdir your_project_dir
cd your_project_dir
export OPENAI_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
aiconsole
On a Mac you might be prompted to install developer tools in order to install aiconsole.
If during installation you get errors like:
WARNING: The script aiconsole is installed in '/Users/user/Library/Python/3.9/bin' which is not on PATH.
Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location.
Run aiconsole like this: /Users/user/Library/Python/3.9/bin/aiconsole
(replace the path with a path that you see in the warnings) instead of aiconsole
.
In your project directory, aiconsole will create a bunch of working files like standard materials and agents
Running Your AIConsole Dev Mode
In order to run your own AIConsole:
- Install poetry
pip install poetry
, update PATH if needed. - Clone the project.
- In the main project folder
aiconsole
run:poetry install
. - In the
aiconsole/web
: run yarn`. - In
aiconsole
run:poetry run aiconsole-dev
.
Requires OPENAI_API_KEY env variable to be set.
Running in another directory in dev mode
Often times you want to host aiconsole working files in another directory, even while developing. In order to do that you need to:
-
Discover the path to your env: poetry env info
-
You will get something like: /Users/user/Library/Caches/pypoetry/virtualenvs/aiconsole-rmLpd4fO-py3.10
-
Execute in your directory of choice the following command:
vepath/bin/python -m aiconsole.init
so in our example that would be:
/Users/user/Library/Caches/pypoetry/virtualenvs/aiconsole-rmLpd4fO-py3.10bin/python -m aiconsole.init
Publishing process
cd web && npm run build && cd .. && poetry build && poetry publish --username __token__ --password ...
Materials
Create .md files in ./materials directory in the following format:
<!---
Description of when this material should be used?
-->
# Title of the material
Actual content of a material
Files are monitored and automatically loaded, then used as context. You can keep there API manuals, login information, prompts and other contextual information.
You can see examples of materials in the ./preset/materials directory
Contributing
We welcome contributions from the community to make AI Console even better. If you have any ideas, bug reports, or feature requests, please open an issue on the GitHub repository. Feel free to submit pull requests as well!
You can also visit our Discord channel for a further discussion.
License
AI Console is open-source software licensed under the Apache License ver. 2.0.
Links
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
Built Distribution
File details
Details for the file aiconsole-0.2.0.tar.gz
.
File metadata
- Download URL: aiconsole-0.2.0.tar.gz
- Upload date:
- Size: 2.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.10.11 Darwin/23.0.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f8387f9c62f0f99f78cc9fa3c2204ea2661032dfa3945bb511c8b920b023e42 |
|
MD5 | a3b596fa40f036ccaeb4a740a3735b56 |
|
BLAKE2b-256 | 24edf1327af870f58386df3463549048719d12f3931c35b23dc4e29c0bdbe8bb |
File details
Details for the file aiconsole-0.2.0-py3-none-any.whl
.
File metadata
- Download URL: aiconsole-0.2.0-py3-none-any.whl
- Upload date:
- Size: 2.4 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.10.11 Darwin/23.0.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 08f9b426623ab7e18b00ac0df83823f15f8631d78b4fc44a46880f5b570cd234 |
|
MD5 | 0d2970b43282c5c32b1aa23e6f349392 |
|
BLAKE2b-256 | cb17b0f56c0dfa1cc06bb8f809f118753a33841408cc15ec6d29df246abcea0b |