103 lines
4.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)
[![GitHub license](https://img.shields.io/github/license/covespace/devchat-vscode.svg)](https://github.com/covespace/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-05-21 16:53:17 +08:00
👉 Install [Visual Studio Code extension](https://github.com/covespace/devchat-vscode) on [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=merico.devchat) and enjoy the enhanced UI 👏
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-19 16:50:30 +08:00
DevChat is an open-source tool that helps you write prompts to generate code and documentation.
2023-05-19 16:37:17 +08:00
It is _not_ limited to performing predefined operations on short code snippets.
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?
- To enable AI to write code, DevChat assists you in providing **the right context** for AI.
2023-05-21 16:30:20 +08:00
![20230519-231038-00 00 00 000-00 00 20 989](https://github.com/covespace/devchat-vscode/assets/592493/cfb96c7f-bd45-4573-810e-17148aac79d1)
2023-05-19 16:37:17 +08:00
Chat history, code, files, directory trees, `git diff --cached`, or the output of any command.
- To apply AI-generated code, DevChat streamlines your **actions to take**.
2023-05-21 16:30:20 +08:00
![20230519-231038-00 00 24 989-00 00 44 688](https://github.com/covespace/devchat-vscode/assets/592493/2a0c4acf-6801-409c-bb18-ac75bae96938)
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-19 16:37:17 +08:00
- To guide AI in your work, define **your own workflows** with DevChat.
2023-05-21 16:30:20 +08:00
![20230519-231038-00 00 45 034-00 01 00 000](https://github.com/covespace/devchat-vscode/assets/592493/5a72e43f-0ed9-446a-81be-3e5f00009961)
More prompt templates, iterative calls to AI, and program operations.
2023-05-19 16:37:17 +08:00
- To suit your preferences, customize **your own experiences** with DevChat.
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.
- Write prompts to create code. Transform prompts into everything.
- It is DevPromptOps
<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
<sub>(This work 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
&nbsp; &nbsp; <img width="220" alt="image" src="https://github.com/covespace/devchat-vscode/assets/592493/c30f76fe-321a-4145-88fa-a0ef3d36bde5">
2023-05-19 19:31:05 +08:00
- 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.
2023-05-21 16:30:20 +08:00
&nbsp; &nbsp; <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-19 19:31:05 +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)!
- Participate in [discussions](https://github.com/covespace/devchat/discussions)!
2023-04-27 14:07:46 +08:00
## Contributing
2023-05-19 19:31:05 +08:00
Issues and pull request are welcome: https://github.com/covespace/devchat-vscode/issues
## 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/).