# OpenAI Copilot
Your life Copilot powered by OpenAI (CLI interface for OpenAI with searching).
Features:
* Web access and Google search support without leaving the terminal.
* Automatically execute any steps predicted from prompt instructions.
* Human interactions on uncertain instructions to avoid inappropriate operations.
## Install
Install the copilot with pip command below:
```sh
pip install openai-copilot
```
## Setup
* OpenAI API key should be set to `OPENAI_API_KEY` environment variable to enable the ChatGPT feature.
* `OPENAI_API_BASE` should be set as well for Azure OpenAI service.
* Google Search API key and CSE ID should be set to `GOOGLE_API_KEY` and `GOOGLE_CSE_ID`.
## How to use
```sh
Usage: openai-copilot [OPTIONS]
Your life Copilot powered by OpenAI
Options:
--version Show the version and exit.
--verbose Enable verbose information of copilot execution steps
--model MODEL OpenAI model to use for copilot execution, default is
gpt-3.5-turbo
--enable-terminal Enable Copilot to run programs within terminal. Enable
with caution since Copilot may execute inappropriate
commands
--help Show this message and exit.
```
Here is a conversation sample (user inputs are after `>>>`)):
```sh
# openai-copilot
>>> What is OpenAI?
OpenAI is an artificial intelligence research laboratory consisting of the for-profit corporation OpenAI LP and its parent company, the non-profit OpenAI Inc. The company is dedicated to advancing digital intelligence in a way that is safe and beneficial for humanity as a whole. OpenAI was founded in 2015 by a group of technology leaders including Elon Musk, Sam Altman, Greg Brockman, and Ilya Sutskever. Its mission is to develop and promote friendly AI for the betterment of all humans.
>>> What are the differences between GPT-4 and GPT-3.5?
According to my search results, one of the main differences between GPT-4 and GPT-3.5 is that while GPT-3.5 is a text-to-text model, GPT-4 is more of a data-to-text model. Additionally, GPT-4 has the advantage of providing more creative replies to prompts. However, it's important to note that GPT-4 is not yet released and there is limited information available about it.
>>>
```
## Run in Kubernetes
```sh
# Run with gpt-4 (default model)
kubectl run -it --rm copilot \
--env="OPENAI_API_KEY=$OPENAI_API_KEY" \
--restart=Never \
--image=ghcr.io/feiskyer/openai-copilot
# Run with a different model and enable verbose outputs
kubectl run -it --rm copilot \
--env="OPENAI_API_KEY=$OPENAI_API_KEY" \
--restart=Never \
--image=ghcr.io/feiskyer/openai-copilot \
-- --model=gpt-3.5-turbo --verbose
```
## Contribution
The project is opensource at github [feiskyer/openai-copilot](https://github.com/feiskyer/openai-copilot) with Apache License.
If you would like to contribute to the project, please follow these guidelines:
1. Fork the repository and clone it to your local machine.
2. Create a new branch for your changes.
3. Make your changes and commit them with a descriptive commit message.
4. Push your changes to your forked repository.
5. Open a pull request to the main repository.
Raw data
{
"_id": null,
"home_page": "https://github.com/feiskyer/openai-copilot",
"name": "openai-copilot",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4",
"maintainer_email": "",
"keywords": "copilot,openai,chatgpt",
"author": "Pengfei Ni",
"author_email": "feiskyer@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/90/92/36bf1facec1d0807fdf781cacc0da63200db81ebece6d6d88cf67410212d/openai_copilot-0.2.5.tar.gz",
"platform": null,
"description": "# OpenAI Copilot\n\nYour life Copilot powered by OpenAI (CLI interface for OpenAI with searching).\n\nFeatures:\n\n* Web access and Google search support without leaving the terminal.\n* Automatically execute any steps predicted from prompt instructions.\n* Human interactions on uncertain instructions to avoid inappropriate operations.\n\n## Install\n\nInstall the copilot with pip command below:\n\n```sh\npip install openai-copilot\n```\n\n## Setup\n\n* OpenAI API key should be set to `OPENAI_API_KEY` environment variable to enable the ChatGPT feature.\n * `OPENAI_API_BASE` should be set as well for Azure OpenAI service.\n* Google Search API key and CSE ID should be set to `GOOGLE_API_KEY` and `GOOGLE_CSE_ID`.\n\n## How to use\n\n```sh\nUsage: openai-copilot [OPTIONS]\n\n Your life Copilot powered by OpenAI\n\nOptions:\n --version Show the version and exit.\n --verbose Enable verbose information of copilot execution steps\n --model MODEL OpenAI model to use for copilot execution, default is\n gpt-3.5-turbo\n --enable-terminal Enable Copilot to run programs within terminal. Enable\n with caution since Copilot may execute inappropriate\n commands\n --help Show this message and exit.\n```\n\nHere is a conversation sample (user inputs are after `>>>`)):\n\n```sh\n# openai-copilot\n>>> What is OpenAI?\nOpenAI is an artificial intelligence research laboratory consisting of the for-profit corporation OpenAI LP and its parent company, the non-profit OpenAI Inc. The company is dedicated to advancing digital intelligence in a way that is safe and beneficial for humanity as a whole. OpenAI was founded in 2015 by a group of technology leaders including Elon Musk, Sam Altman, Greg Brockman, and Ilya Sutskever. Its mission is to develop and promote friendly AI for the betterment of all humans.\n>>> What are the differences between GPT-4 and GPT-3.5?\nAccording to my search results, one of the main differences between GPT-4 and GPT-3.5 is that while GPT-3.5 is a text-to-text model, GPT-4 is more of a data-to-text model. Additionally, GPT-4 has the advantage of providing more creative replies to prompts. However, it's important to note that GPT-4 is not yet released and there is limited information available about it.\n>>>\n```\n\n## Run in Kubernetes\n\n```sh\n# Run with gpt-4 (default model)\nkubectl run -it --rm copilot \\\n --env=\"OPENAI_API_KEY=$OPENAI_API_KEY\" \\\n --restart=Never \\\n --image=ghcr.io/feiskyer/openai-copilot\n\n# Run with a different model and enable verbose outputs\nkubectl run -it --rm copilot \\\n --env=\"OPENAI_API_KEY=$OPENAI_API_KEY\" \\\n --restart=Never \\\n --image=ghcr.io/feiskyer/openai-copilot \\\n -- --model=gpt-3.5-turbo --verbose\n```\n\n## Contribution\n\nThe project is opensource at github [feiskyer/openai-copilot](https://github.com/feiskyer/openai-copilot) with Apache License.\n\nIf you would like to contribute to the project, please follow these guidelines:\n\n1. Fork the repository and clone it to your local machine.\n2. Create a new branch for your changes.\n3. Make your changes and commit them with a descriptive commit message.\n4. Push your changes to your forked repository.\n5. Open a pull request to the main repository.\n",
"bugtrack_url": null,
"license": "",
"summary": "OpenAI Copilot",
"version": "0.2.5",
"project_urls": {
"Homepage": "https://github.com/feiskyer/openai-copilot",
"Repository": "https://github.com/feiskyer/openai-copilot"
},
"split_keywords": [
"copilot",
"openai",
"chatgpt"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9869fc86c44911ef972314506383278b8b96f87d46a34c46f6c3f1f44128804c",
"md5": "25bf25332b1b33bd3930dc584d73e7ed",
"sha256": "3f42a1c48f03ede486a2c070f37e0269229d4acb2d0fbb8d11beb5fcbaabe1d3"
},
"downloads": -1,
"filename": "openai_copilot-0.2.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "25bf25332b1b33bd3930dc584d73e7ed",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4",
"size": 10586,
"upload_time": "2023-10-08T07:38:16",
"upload_time_iso_8601": "2023-10-08T07:38:16.004414Z",
"url": "https://files.pythonhosted.org/packages/98/69/fc86c44911ef972314506383278b8b96f87d46a34c46f6c3f1f44128804c/openai_copilot-0.2.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "909236bf1facec1d0807fdf781cacc0da63200db81ebece6d6d88cf67410212d",
"md5": "b305d991f5bbf0286f5b2e27c7f7758a",
"sha256": "1ba0d3f05f584dc0d72907622bd7da8a732d279129221aaa2bd882d19d4153bc"
},
"downloads": -1,
"filename": "openai_copilot-0.2.5.tar.gz",
"has_sig": false,
"md5_digest": "b305d991f5bbf0286f5b2e27c7f7758a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4",
"size": 8798,
"upload_time": "2023-10-08T07:38:19",
"upload_time_iso_8601": "2023-10-08T07:38:19.698316Z",
"url": "https://files.pythonhosted.org/packages/90/92/36bf1facec1d0807fdf781cacc0da63200db81ebece6d6d88cf67410212d/openai_copilot-0.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-08 07:38:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "feiskyer",
"github_project": "openai-copilot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "openai-copilot"
}
JSON
