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" >
2023-05-18 16:27:21 +08:00
[](http://makeapullrequest.com)
[](https://marketplace.visualstudio.com/items?itemName=merico.devchat)
[](https://marketplace.visualstudio.com/items?itemName=merico.devchat)
[](https://github.com/covespace/devchat-vscode/blob/main/LICENSE)
2023-05-19 16:50:30 +08:00
[](https://discord.gg/9t3yrbBUXD)
2023-05-18 16:27:21 +08:00
2023-05-23 23:56:25 +08:00
👉 Install [Visual Studio Code extension ](https://github.com/covespace/devchat-vscode ) from [Visual Studio Marketplace ](https://marketplace.visualstudio.com/items?itemName=merico.devchat ) and enjoy DevChat 👏
2023-04-21 06:44:26 +08:00
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-05-23 23:56:25 +08:00
DevChat is the open-source solution to help you write prompts to generate code and documentation, going beyond simple code auto-completion.
It isn't limited to performing predefined operations on short code snippets.
2023-05-19 16:37:17 +08:00
DevChat is the way developers interact and collaborate with AI.
2023-05-21 16:53:17 +08:00
💬 Build the future with prompts, _not_ code.
2023-05-19 16:37:17 +08:00
## Why DevChat?
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-05-19 16:37:17 +08:00
2023-05-23 23:56:25 +08:00
2023-05-19 16:37:17 +08:00
2023-05-23 23:56:25 +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-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-05-23 23:56:25 +08:00
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.
## What is Prompt-Centric Software Development (PSSD)?
- The traditional code-centric paradigm is evolving.
2023-05-23 23:56:25 +08:00
- Write prompts to create code. Transform prompts into all artifacts in software engineering.
2023-05-19 16:37:17 +08:00
2023-05-21 19:51:19 +08:00
< img width = "600" alt = "image" src = "https://github.com/covespace/devchat/assets/592493/dd32e900-92fd-4fa4-8489-96ed17ab5e0e" >
< 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
< img width = "500" alt = "image" src = "https://github.com/covespace/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-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-05-21 16:30:20 +08:00
< img width = "220" alt = "image" src = "https://github.com/covespace/devchat-vscode/assets/592493/c30f76fe-321a-4145-88fa-a0ef3d36bde5" >
2023-05-23 23:56:25 +08:00
- Since DevChat is designed for developers, it requires a Git repository folder to store metadata. Therefore, be sure to open a Git project.
- Set your [OpenAI API Key ](https://platform.openai.com/account/api-keys ) by running `export OPENAI_API_KEY="[sk-...]"` (or DevChat access key by DEVCHAT_KEY).
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-04-21 06:44:26 +08:00
2023-05-21 16:30:20 +08:00
< img width = "400" alt = "image" src = "https://github.com/covespace/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-04-21 06:44:26 +08:00
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 )!
- Participate in [discussions ](https://github.com/covespace/devchat/discussions )!
2023-04-21 06:44:26 +08:00
2023-04-27 14:07:46 +08:00
## Contributing
2023-04-21 06:44:26 +08:00
2023-05-19 19:31:05 +08:00
Issues and pull request are welcome: https://github.com/covespace/devchat-vscode/issues
2023-04-21 06:44:26 +08:00
2023-05-19 10:46:35 +08:00
## 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
hello@merico .dev
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/ ).
