ishangsf/DeepCodeGeniusWeb-vscode
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Jinglei Ren 2023-05-19 19:31:05 +08:00 committed by GitHub
parent 0a7703e999
commit 58d9e137c9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -37,12 +37,14 @@ DevChat is the way developers interact and collaborate with AI.
Chat history, code, files, directory trees, `git diff --cached`, or the output of any command. Chat history, code, files, directory trees, `git diff --cached`, or the output of any command.
<img width="600" alt="image" src="https://github.com/covespace/devchat-vscode/assets/592493/fa66d71e-9ccb-4527-ad2d-d930109769d3"> <img width="500" alt="image" src="https://github.com/covespace/devchat-vscode/assets/592493/fa66d71e-9ccb-4527-ad2d-d930109769d3">
- To apply AI-generated code, DevChat streamlines your **actions to take**. - To apply AI-generated code, DevChat streamlines your **actions to take**.
View diffs, copy or insert, commit & sync, or export to documentation, wikis, and more. View diffs, copy or insert, commit & sync, or export to documentation, wikis, and more.
<img width="600" alt="image" src="https://github.com/covespace/devchat-vscode/assets/592493/eca1b840-5e48-42d9-a23f-879744531e9f">
- To guide AI in your work, define **your own workflows** with DevChat. - To guide AI in your work, define **your own workflows** with DevChat.
Prompt templates, iterative calls to AI, and program operations. Prompt templates, iterative calls to AI, and program operations.
@ -64,43 +66,36 @@ DevChat is the way developers interact and collaborate with AI.
*** ***
## Installation ## Quick Start
1. Open Visual Studio Code - Install [Visual Studio Code](https://code.visualstudio.com/download).
2. Press `Ctrl+P` to open the Quick Open dialog - Open the Extensions view (⇧⌘X), search for DevChat, and install the extension:
3. Type `ext install merico.devchat` and press `Enter`
4. Install devchat package by `pip install devchat` <img width="200" alt="image" src="https://github.com/covespace/devchat-vscode/assets/592493/415df4aa-66d6-46e4-a30d-8bba6277028c">
5. setting your OPENAI_API_KEY in setting/DevChat
- Since DevChat is designed for developers, it requires a Git repository folder to store metadata. Therefore, open a Git project.
- Set your [OpenAI API Key](https://platform.openai.com/account/api-keys) by running `export OPENAI_API_KEY="sk-..."`.
- Click on the DevChat icon in the status bar. If the API key setting is not configured, it will prompt you to enter it. Simply input the key.
## Usage <img width="400" alt="image" src="https://github.com/covespace/devchat-vscode/assets/592493/bcccbf20-0d30-46f4-b19f-5f532c1caf85">
1. Open the chat panel by clicking on the "Chat with Bot" view in the Explorer or by running the "DevChat" command from the Command Palette (`Ctrl+Shift+P`). - We recommend dragging the DevChat logo from the left sidebar to the right sidebar to avoid overlapping with the Explorer.
2. Type your question or prompt in the input field and press `Enter` to send it to the AI bot.
3. To add code snippets or files to the chat, right-click on the selected code or file in the editor and choose "Add to DevChat" from the context menu.
## Configuration ## Community
You can configure the following settings in your `settings.json` file: - Join our [Discord](https://discord.gg/9t3yrbBUXD)!
- Participate in [discussions](https://github.com/covespace/devchat/discussions)!
- `DevChat.llmModel`: Select the AI model to use (default: "OpenAI").
- `DevChat.maxLogCount`: Limit the number of prompts to output (default: 20).
- `DevChat.OpenAI.model`: Specify the AI model (default: "gpt-4").
- `DevChat.OpenAI.temperature`: Specify the AI model temperature (default: 0.2).
- `DevChat.OpenAI.stream`: Specify the AI model stream (default: true).
- `DevChat.OpenAI.tokensPerPrompt`: Specify the number of tokens for each prompt (default: 6000).
- `DevChat.OpenAI.useHistoryPrompt`: Use history prompts as context (default: true).
- `DevChat.OpenAI.apiKey`: OpenAI API Key (default: "").
- `DevChat.OpenAI.EndPoint`: OpenAI API server (default: "").
## Contributing ## Contributing
If you have any suggestions or issues, please feel free to open an issue or submit a pull request on the [GitHub repository](https://github.com/covespace/devchat-vscode.git). Issues and pull request are welcome: https://github.com/covespace/devchat-vscode/issues
## Automated Publishing Process ## Automated Publishing Process
Check out our [Automated Publishing Process](./docs/publish.md) for a detailed walkthrough of how we manage the automated release of new versions for the DevChat VSCode Extension. Check out our [Automated Publishing Process](./docs/publish.md) for a detailed walkthrough of how we manage the automated release of new versions for the DevChat VSCode Extension.
## Contact Information ## Contact Information
hello@merico.dev hello@merico.dev
We are creators of Apache DevLake and CNCF DevStream.