|
2 | 2 |
|
3 | 3 | Codeye is a revolutionary [Visual Studio Code](https://code.visualstudio.com/) extension and CLI that transforms your coding experience. Designed to boost developer productivity by 10x, Codeye can generate entire software projects, install developer tools, manage servers, and much more—all from simple text prompts. |
4 | 4 |
|
5 | | - |
| 5 | + |
6 | 6 |
|
7 | | -## 🌟 Features |
| 7 | +## Features |
8 | 8 |
|
9 | 9 | - **AI-Powered Code Generation**: Generate code snippets or entire projects effortlessly. |
10 | 10 | - **Automated Software Installation**: Quickly set up developer tools and environments. |
11 | 11 | - **Server Management**: Easily deploy and manager stack, servers across languages. |
12 | 12 | - **Seamless Integration**: Works directly within your favorite code editor, [Visual Studio Code](https://code.visualstudio.com/). |
13 | 13 |
|
14 | | -## 🚀 Getting Started |
| 14 | +## Getting Started |
15 | 15 |
|
16 | 16 | 1. **Install Codeye**: Search for **Codeye** in the [Visual Studio Code](https://code.visualstudio.com/) **Extensions** tab or visit the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=codeye.codeye) for quick installation. |
17 | 17 | 2. **Select AI Model**: Navigate to `Settings` > `Extensions` > `Codeye` and choose you desired AI model. |
18 | 18 | 3. **Enter Credentials**: Enter your [Anthropic](https://www.anthropic.com), [Google AI Studio](https://ai.google.dev) or [OpenAI](https://openai.com/) credentials based on the selected model. |
19 | 19 |
|
20 | | -## 🛠️ How to Use |
| 20 | +## How to Use |
21 | 21 |
|
22 | 22 | There are many ways you could launch **Codeye** once installed. |
23 | 23 |
|
24 | 24 | ### From Command Palette |
25 | 25 |
|
26 | 26 | Hit `CMD + SHIFT + P` and start a **Codeye** session from the **Command Palette**. |
27 | 27 |
|
28 | | - |
| 28 | + |
29 | 29 |
|
30 | 30 | ### From Terminal |
31 | 31 |
|
32 | 32 | Start a Codeye session from the provided terminal profile. |
33 | 33 |
|
34 | | - |
| 34 | + |
35 | 35 |
|
36 | | -## ⚠️ Disclaimer |
| 36 | + |
| 37 | +## Install |
| 38 | + |
| 39 | +Clone the repository, navigate to project folder and run below commands: |
| 40 | + |
| 41 | +```shell |
| 42 | +# use a supported node.js version |
| 43 | +nvm install && nvm use |
| 44 | + |
| 45 | +# install node.js dependencies |
| 46 | +yarn install |
| 47 | + |
| 48 | +# create a .env file |
| 49 | +cp .env.dist .env |
| 50 | + |
| 51 | +# update values in .env |
| 52 | +``` |
| 53 | + |
| 54 | +Use below command to run working copy of the tool: |
| 55 | + |
| 56 | +```shell |
| 57 | +npm run debug |
| 58 | +``` |
| 59 | + |
| 60 | +## Usage |
| 61 | + |
| 62 | +To run as [Visual Studio Code](https://code.visualstudio.com) extension, open the project is [Visual Studio Code](https://code.visualstudio.com) and hit `F5` to start a new [Visual Studio Code](https://code.visualstudio.com) window with this extension preloaded. |
| 63 | + |
| 64 | +## Publishing |
| 65 | + |
| 66 | +Before publishing, package your extension as `vsix` file. |
| 67 | + |
| 68 | +```shell |
| 69 | +npx vsce package |
| 70 | +``` |
| 71 | + |
| 72 | +To publish to [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=codeye.codeye), use below commands: |
| 73 | + |
| 74 | +```shell |
| 75 | +npx vsce publish |
| 76 | +``` |
| 77 | + |
| 78 | +## Disclaimer |
37 | 79 |
|
38 | 80 | This is an experimental tool currently in its Early Access Program (EAP). Your feedback is incredibly valuable for shaping its future. |
0 commit comments