117 lines
6.6 KiB
Markdown
Raw Normal View History

2023-05-12 12:02:08 +08:00
<div align="center">
<br/>
<img src="assets/devchat.png" width="100px" alt="">
<br/>
2023-04-14 08:05:41 +08:00
2023-05-12 12:02:08 +08:00
# DevChat Visual Studio Code Extension
2023-04-14 08:05:41 +08:00
2023-05-12 12:02:08 +08:00
</div>
<br>
<div align="left">
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![VS Code Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/merico.devchat?logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=merico.devchat)
[![VS Code Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/merico.devchat?logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=merico.devchat)
2023-06-13 11:09:26 +08:00
[![GitHub license](https://img.shields.io/github/license/devchat-ai/devchat-vscode.svg)](https://github.com/devchat-ai/devchat-vscode/blob/main/LICENSE)
2023-05-19 16:50:30 +08:00
[![Discord Chat](https://img.shields.io/discord/1106908489114206309?logo=discord)](https://discord.gg/9t3yrbBUXD)
2023-06-13 11:09:26 +08:00
👉 Install [Visual Studio Code extension](https://github.com/devchat-ai/devchat-vscode) from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=merico.devchat) and enjoy DevChat 👏
2023-05-19 16:50:30 +08:00
2023-05-19 16:37:17 +08:00
***
2023-04-14 08:05:41 +08:00
2023-05-19 16:37:17 +08:00
## What is DevChat?
2023-08-10 20:27:39 +08:00
DevChat is an open-source platform that empowers developers to leverage AI for code generation and documentation. We aim to go beyond simple code auto-completion and limited operations on brief code snippets. DevChat offers a highly *practical* and *effective* way for developers to interact and collaborate with AI.
2023-05-19 16:37:17 +08:00
## Why DevChat?
2023-08-10 23:45:10 +08:00
While there are many AI coding tools available, we created DevChat based on our unique insights gained from generating tens of thousands of lines of code. If you agree with our perspectives outlined below, DevChat could be the perfect choice for you.
- The value of prompt "engineering" is often overestimated. While a well-crafted prompt template can be helpful, it's not worth spending more than an hour or two to create a few effective ones and share them with your team.
- The art of writing prompts is a skill honed through practice. It's not about templates or engineering, but about refining individual prompts for specific tasks on a case-by-case basis.
- The key to success lies in embedding the right context in a prompt. This isn't about the token limit of an AI model. Even with infinite tokens, AI would struggle to deliver good results without proper separation of concerns.
- Use AI only when it truly adds value. The issue of AI hallucination is less of a concern compared to our overestimation of AI's capabilities. What we need is a tool that boosts productivity, not merely an experimental tool.
## Explore Our Features
2023-05-23 23:56:25 +08:00
- Great output requires great input, to maximize the power of AI, DevChat assists you seamlessly to **provide the right context** to the AI.
2023-05-19 16:37:17 +08:00
Chat history, code, files, directory trees, `git diff --cached`, or the output of any command.
2023-05-23 23:56:25 +08:00
2023-06-13 11:09:26 +08:00
![20230523-220717-cut-merged-1684855581224](https://github.com/devchat-ai/devchat-vscode/assets/592493/16bc09e4-4185-4bcb-8d5a-2173b0bfc3ed)
2023-05-19 16:37:17 +08:00
2023-06-13 11:09:26 +08:00
![20230523-220717-00 00 28 206-00 00 44 950](https://github.com/devchat-ai/devchat-vscode/assets/592493/d5556310-bc7f-4abb-86a3-8e76e4aa720e)
2023-05-19 16:37:17 +08:00
2023-08-10 23:45:10 +08:00
Once you have generated code with AI, DevChat **streamlines the actions** to properly integrate and ship.
2023-05-19 16:37:17 +08:00
2023-05-21 16:30:20 +08:00
View diffs, copy or insert, commit & sync, or export to documentation, wikis, and more.
2023-05-19 19:31:05 +08:00
2023-06-13 11:09:26 +08:00
![20230523-220717-00 00 46 728-00 01 00 120](https://github.com/devchat-ai/devchat-vscode/assets/592493/a2bab011-8e31-47a9-838f-36e43cd2e98c)
2023-05-23 23:56:25 +08:00
2023-05-19 16:37:17 +08:00
- To guide AI in your work, define **your own workflows** with DevChat.
2023-06-13 11:09:26 +08:00
![20230523-220717-00 01 14 614-00 01 41 680](https://github.com/devchat-ai/devchat-vscode/assets/592493/94502efd-781b-448d-b945-dffcc41d7af3)
2023-05-19 16:37:17 +08:00
2023-05-23 23:56:25 +08:00
Explore more prompt templates, iterative calls to AI, and program operations.
- To ensure the experience fits your preferences, customize **your own experiences** with DevChat.
2023-05-19 16:37:17 +08:00
Open-source, no waiting for opaque feature schedules. Access GPT-4 today and more models in the future.
2023-05-23 23:59:36 +08:00
## What is Prompt-Centric Software Development (PCSD)?
2023-05-19 16:37:17 +08:00
- The traditional code-centric paradigm is evolving.
2023-05-23 23:59:36 +08:00
- Write prompts to create code. Transform prompts into all the artifacts in software engineering.
2023-05-19 16:37:17 +08:00
2023-06-13 11:09:26 +08:00
<img width="600" alt="image" src="https://github.com/devchat-ai/devchat/assets/592493/dd32e900-92fd-4fa4-8489-96ed17ab5e0e">
2023-05-21 19:51:19 +08:00
<sub>(This image is licensed by devchat.ai under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.)</sub>
2023-05-23 23:56:25 +08:00
- We like to call it DevPromptOps
2023-05-19 16:37:17 +08:00
2023-06-13 11:09:26 +08:00
<img width="500" alt="image" src="https://github.com/devchat-ai/devchat/assets/592493/e8e1215b-53b0-4473-ab00-0665d33f204a">
2023-05-21 16:53:17 +08:00
2023-05-21 19:51:19 +08:00
<sub>(This image is licensed by devchat.ai under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.)</sub>
2023-05-19 16:37:17 +08:00
***
2023-04-27 14:07:46 +08:00
2023-05-19 19:31:05 +08:00
## Quick Start
2023-04-14 08:05:41 +08:00
2023-07-14 07:46:28 +08:00
> Chinese: [中文安装配置指南](https://zh.devchat.blog/devchat-vscode-installation-guide).
2023-05-19 19:31:05 +08:00
- Install [Visual Studio Code](https://code.visualstudio.com/download).
- Open the Extensions view (⇧⌘X), search for DevChat, and install the extension:
2023-06-13 11:09:26 +08:00
&nbsp; &nbsp; <img width="220" alt="image" src="https://github.com/devchat-ai/devchat-vscode/assets/592493/c30f76fe-321a-4145-88fa-a0ef3d36bde5">
2023-05-21 16:30:20 +08:00
2023-06-09 00:00:47 +08:00
- Since DevChat is designed for developers, it requires a Git or SVN repository folder to store metadata. Therefore, be sure to open a Git or SVN project.
- Set your [OpenAI API Key](https://platform.openai.com/account/api-keys) by running `export OPENAI_API_KEY="[sk-...]"` (or set it to your DevChat access key instead).
2023-05-19 19:31:05 +08:00
- 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.
2023-06-13 11:09:26 +08:00
&nbsp; &nbsp; <img width="400" alt="image" src="https://github.com/devchat-ai/devchat-vscode/assets/592493/56f261c0-3aae-4df6-b699-c9e757bd91c1">
2023-04-14 08:05:41 +08:00
2023-05-21 19:51:19 +08:00
- We recommend dragging the DevChat logo from the left sidebar to **the right sidebar** to avoid overlapping with the Explorer.
2023-05-19 19:31:05 +08:00
## Community
2023-04-14 08:05:41 +08:00
2023-05-19 19:31:05 +08:00
- Join our [Discord](https://discord.gg/9t3yrbBUXD)!
2023-06-13 11:09:26 +08:00
- Participate in [discussions](https://github.com/devchat-ai/devchat/discussions)!
2023-04-27 14:07:46 +08:00
## Contributing
2023-07-08 16:49:58 +08:00
Issues and pull request are welcome:
- https://github.com/devchat-ai/devchat/issues
- https://github.com/devchat-ai/devchat-vscode/pulls
## 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.
2023-04-27 14:07:46 +08:00
## Contact Information
2023-05-19 16:37:17 +08:00
2023-08-10 23:45:10 +08:00
hello@devchat.ai
2023-05-19 19:31:05 +08:00
2023-05-21 16:30:20 +08:00
We are creators of [Apache DevLake](https://devlake.apache.org/).