# zkApp Umstad CLI Agent
## Introduction
Introducing the zkApps Umstad AI Agent, your specialized assistant in the realm of the MINA Protocol and o1js. This agent, powered by the advanced GPT language model, is tailored to support developers in creating, debugging and testing zkApps smart contracts. It offers comprehensive guidance and expertise specifically for those working on zkApps development within the MINA ecosystem.
## Installation
```bash
pip install zkappumstad
```
It is suggested that before using the tool create a folder and use it inside the folder.
```bash
mkdir new_folder
cd new_folder
```
Create zk project and wait 10-15 seconds:
```bash
zkumstad-create
```
Go into the zkapps project folder and you can optionally open the project in editor:
```bash
cd initial_project
code .
```
Then, you can run and use the tool:
```bash
zkumstad-start
```
## Features & Architecture
Currently uses our own API to send queries. No need to post your OPENAI API KEY. However, it will be needed to POST the query with OPENAI API KEY later on.
#### Retrieval Tools
- Documentations
- Code Snippets
- Projects
- Issues
#### Coder Agent
- Gets related context and writes code
- Builds and gets errors
- Debugs errors
- Fix and retry code
## Usage
#### Commands
- ```zkumstad-start```: Runs the tool.
- ```zkumstad-create```: Initialize zkapps project named initial_project.
- You can save your conversations by writing 'save' to console as a Markdown file.
- You can reset the conversation by writing 'reset'.
- Write 'quit' to terminate the agent.
#### Specifications
- You Must Delete smart contract and test files from src folder before creating new contract in order to build.
### Best Practices for Agent
- Specify your project requirements in detail and collaborate with the AI Agent.
- In order to query about issues, errors etc. start with "I have an issue...".
# Support
For any technical issues or further inquiries, please contact our support team at [berkingurcan@gmail.com](mailto:berkingurcan@gmail.com).
# Acknowledgements
Special thanks to the Mina Protocol zkIgnite program for funding the project and all contributors to this project.
Raw data
{
"_id": null,
"home_page": "https://github.com/UmstadAI/zkAppUmstad/tree/main/cli",
"name": "zkappumstad",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "zkapps,zkappumstad,zkapps agent",
"author": "Berkin Gurcan, Dogukan Akar",
"author_email": "berkingurcan@gmail.com, dogukanakarc@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/5f/45/08b111f16d9b16c3c92452f53c164bd48479ad6f1ada39167a8a2582380a/zkappumstad-0.1.6.tar.gz",
"platform": null,
"description": "# zkApp Umstad CLI Agent\n\n## Introduction\n\nIntroducing the zkApps Umstad AI Agent, your specialized assistant in the realm of the MINA Protocol and o1js. This agent, powered by the advanced GPT language model, is tailored to support developers in creating, debugging and testing zkApps smart contracts. It offers comprehensive guidance and expertise specifically for those working on zkApps development within the MINA ecosystem.\n\n## Installation\n\n```bash\npip install zkappumstad\n```\n\nIt is suggested that before using the tool create a folder and use it inside the folder.\n\n```bash\nmkdir new_folder\ncd new_folder\n```\n\nCreate zk project and wait 10-15 seconds:\n```bash\nzkumstad-create\n```\n\nGo into the zkapps project folder and you can optionally open the project in editor:\n```bash\ncd initial_project\ncode .\n```\n\nThen, you can run and use the tool:\n```bash\nzkumstad-start\n```\n\n## Features & Architecture\nCurrently uses our own API to send queries. No need to post your OPENAI API KEY. However, it will be needed to POST the query with OPENAI API KEY later on.\n\n\n#### Retrieval Tools\n- Documentations\n- Code Snippets\n- Projects\n- Issues\n\n#### Coder Agent\n- Gets related context and writes code\n- Builds and gets errors\n- Debugs errors\n- Fix and retry code\n\n## Usage\n#### Commands\n- ```zkumstad-start```: Runs the tool.\n- ```zkumstad-create```: Initialize zkapps project named initial_project.\n- You can save your conversations by writing 'save' to console as a Markdown file.\n- You can reset the conversation by writing 'reset'.\n- Write 'quit' to terminate the agent.\n\n#### Specifications\n- You Must Delete smart contract and test files from src folder before creating new contract in order to build.\n\n### Best Practices for Agent\n- Specify your project requirements in detail and collaborate with the AI Agent.\n- In order to query about issues, errors etc. start with \"I have an issue...\".\n\n\n# Support\n\nFor any technical issues or further inquiries, please contact our support team at [berkingurcan@gmail.com](mailto:berkingurcan@gmail.com).\n\n# Acknowledgements\n\nSpecial thanks to the Mina Protocol zkIgnite program for funding the project and all contributors to this project.\n",
"bugtrack_url": null,
"license": "",
"summary": "CLI AI Agent for zkApps Developers",
"version": "0.1.6",
"project_urls": {
"Homepage": "https://github.com/UmstadAI/zkAppUmstad/tree/main/cli"
},
"split_keywords": [
"zkapps",
"zkappumstad",
"zkapps agent"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "64ecec76c5cb89ed3692dbfbeef00c4f4c1db41a1d39e333bd760453a37d917e",
"md5": "beb5ee7e2add0c7da843d0f3a125748a",
"sha256": "ecc45c5b6f5c78a9885235b1e21a66de1651186d0ef0021f4b941e3ea4597210"
},
"downloads": -1,
"filename": "zkappumstad-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "beb5ee7e2add0c7da843d0f3a125748a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 24892,
"upload_time": "2024-01-10T14:33:34",
"upload_time_iso_8601": "2024-01-10T14:33:34.521813Z",
"url": "https://files.pythonhosted.org/packages/64/ec/ec76c5cb89ed3692dbfbeef00c4f4c1db41a1d39e333bd760453a37d917e/zkappumstad-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5f4508b111f16d9b16c3c92452f53c164bd48479ad6f1ada39167a8a2582380a",
"md5": "e29a9140ae3e029d757c87ff293e27b5",
"sha256": "83056267c6fb31cd537ca6d343ce4227967e28e6b19d7de1ad82dbd63427ef1c"
},
"downloads": -1,
"filename": "zkappumstad-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "e29a9140ae3e029d757c87ff293e27b5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 17428,
"upload_time": "2024-01-10T14:33:37",
"upload_time_iso_8601": "2024-01-10T14:33:37.397464Z",
"url": "https://files.pythonhosted.org/packages/5f/45/08b111f16d9b16c3c92452f53c164bd48479ad6f1ada39167a8a2582380a/zkappumstad-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-10 14:33:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "UmstadAI",
"github_project": "zkAppUmstad",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "zkappumstad"
}
JSON
