| Name | blueshell JSON |
| Version |
0.0.7
JSON |
| download |
| home_page | https://github.com/MarchLiu/blue-shell |
| Summary | Blue Shell is a chat shell for local ai service endpoint |
| upload_time | 2023-12-06 13:18:23 |
| maintainer | |
| docs_url | None |
| author | marsliu |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 Mars Liu Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Blue Shell
Blue Shell is a AI Chat Shell for local service. 0.0.1 version support ollama
## Installation
```
pip install blueshell
```
## Usage
At simplest, run
```shell
python -m blueshell.shell -m "codellama"
```
If ollama isn't listening default port, for example 11435. we could pass a url parameter like this:
```shell
python -m blueshell.shell -m "codellama" --url http://127.0.0.1:11435
```
More options could run help:
```shell
$ python -m blueshell.shell --help
usage: Blue Shell [-h] [--url URL] [-p PROMPT] [-m MODEL]
[-f {markdown,plain,json}] [-s SYSTEM]
A AI assistant for local ai service
options:
-h, --help show this help message and exit
--url URL
-p PROMPT, --prompt PROMPT
-m MODEL, --model MODEL
-f {markdown,plain,json}, --format {markdown,plain,json}
-s SYSTEM, --system SYSTEM
Powered By Python
```
You can list all models in ollama:
```shell
$ python -m blueshell.list
```
List has a option is url:
```shell
$ python -m blueshell.list --url http://127.0.0.1:11435
```
## What's New
### 0.0.1
support ollama
### 0.0.2
document typo
### 0.0.3
print feedback as markdown
### 0.0.4
fixed dependencies miss
### 0.0.5
- add list command
- add format argument
- C-c interrupt repl and continue
- Improved User Experience
### 0.0.6
support json format pretty
### 0.0.7
save history in ~/.blueshell_history
Raw data
{
"_id": null,
"home_page": "https://github.com/MarchLiu/blue-shell",
"name": "blueshell",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "marsliu",
"author_email": "Liu Xin <mars.liu@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/14/bf/fecdb397296f292d5e17dfa438a3363d36bed239b268ae3c782e60ca4277/blueshell-0.0.7.tar.gz",
"platform": null,
"description": "# Blue Shell\n\nBlue Shell is a AI Chat Shell for local service. 0.0.1 version support ollama\n\n## Installation\n\n```\npip install blueshell\n```\n\n## Usage\n\nAt simplest, run \n\n```shell\npython -m blueshell.shell -m \"codellama\" \n```\n\nIf ollama isn't listening default port, for example 11435. we could pass a url parameter like this:\n\n```shell\npython -m blueshell.shell -m \"codellama\" --url http://127.0.0.1:11435\n```\n\nMore options could run help:\n\n```shell\n$ python -m blueshell.shell --help\nusage: Blue Shell [-h] [--url URL] [-p PROMPT] [-m MODEL]\n [-f {markdown,plain,json}] [-s SYSTEM]\n\nA AI assistant for local ai service\n\noptions:\n -h, --help show this help message and exit\n --url URL\n -p PROMPT, --prompt PROMPT\n -m MODEL, --model MODEL\n -f {markdown,plain,json}, --format {markdown,plain,json}\n -s SYSTEM, --system SYSTEM\n\nPowered By Python\n\n```\n\nYou can list all models in ollama:\n\n```shell\n$ python -m blueshell.list\n```\n\nList has a option is url:\n\n```shell\n$ python -m blueshell.list --url http://127.0.0.1:11435\n```\n\n\n## What's New\n\n### 0.0.1\n\nsupport ollama\n\n### 0.0.2\n\ndocument typo\n\n### 0.0.3\n\nprint feedback as markdown\n\n### 0.0.4\n\nfixed dependencies miss\n\n### 0.0.5\n\n- add list command\n- add format argument\n- C-c interrupt repl and continue\n- Improved User Experience\n\n### 0.0.6\n\nsupport json format pretty\n\n### 0.0.7\n\nsave history in ~/.blueshell_history\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Mars Liu Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Blue Shell is a chat shell for local ai service endpoint",
"version": "0.0.7",
"project_urls": {
"Homepage": "https://github.com/MarchLiu/blue-shell",
"Issues": "https://github.com/MarchLiu/blue-shell/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7d5424076263d76c35a819cd7dd17d5ef7657bfb9bb92e9443a7a13207084628",
"md5": "bae4300e39a71202cf8d4a20513599ee",
"sha256": "7cbbbdaca13a138637de084fa9fd4266e954b3a8e4de693a13e312dd48579ac6"
},
"downloads": -1,
"filename": "blueshell-0.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bae4300e39a71202cf8d4a20513599ee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5562,
"upload_time": "2023-12-06T13:18:21",
"upload_time_iso_8601": "2023-12-06T13:18:21.602781Z",
"url": "https://files.pythonhosted.org/packages/7d/54/24076263d76c35a819cd7dd17d5ef7657bfb9bb92e9443a7a13207084628/blueshell-0.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "14bffecdb397296f292d5e17dfa438a3363d36bed239b268ae3c782e60ca4277",
"md5": "18c374a179188e4459bb10ce49a478c7",
"sha256": "f3b184229cf35bda4c7f08e6b54a726b004efd6dde46202837c5297825087232"
},
"downloads": -1,
"filename": "blueshell-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "18c374a179188e4459bb10ce49a478c7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4721,
"upload_time": "2023-12-06T13:18:23",
"upload_time_iso_8601": "2023-12-06T13:18:23.570846Z",
"url": "https://files.pythonhosted.org/packages/14/bf/fecdb397296f292d5e17dfa438a3363d36bed239b268ae3c782e60ca4277/blueshell-0.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-06 13:18:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MarchLiu",
"github_project": "blue-shell",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "blueshell"
}
