Skip to content

Commit acc94f2

Browse files
Move screenshots in smae repo.
1 parent c30b2f8 commit acc94f2

File tree

6 files changed

+50
-54
lines changed

6 files changed

+50
-54
lines changed

.nvmrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
20
1+
lts/hydrogen

README-internal.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

README.md

Lines changed: 49 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,79 @@
22

33
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.
44

5-
![Screenshot](https://raw.githubusercontent.com/codeye-ai/codeye-assets/main/images/usage.png)
5+
![Screenshot](images/usage.png)
66

7-
## 🌟 Features
7+
## Features
88

99
- **AI-Powered Code Generation**: Generate code snippets or entire projects effortlessly.
1010
- **Automated Software Installation**: Quickly set up developer tools and environments.
1111
- **Server Management**: Easily deploy and manager stack, servers across languages.
1212
- **Seamless Integration**: Works directly within your favorite code editor, [Visual Studio Code](https://code.visualstudio.com/).
1313

14-
## 🚀 Getting Started
14+
## Getting Started
1515

1616
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.
1717
2. **Select AI Model**: Navigate to `Settings` > `Extensions` > `Codeye` and choose you desired AI model.
1818
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.
1919

20-
## 🛠️ How to Use
20+
## How to Use
2121

2222
There are many ways you could launch **Codeye** once installed.
2323

2424
### From Command Palette
2525

2626
Hit `CMD + SHIFT + P` and start a **Codeye** session from the **Command Palette**.
2727

28-
![Command](https://raw.githubusercontent.com/codeye-ai/codeye-assets/main/images/command-palette.png)
28+
![Command](images/command-palette.png)
2929

3030
### From Terminal
3131

3232
Start a Codeye session from the provided terminal profile.
3333

34-
![Terminal Profile](https://raw.githubusercontent.com/codeye-ai/codeye-assets/main/images/terminal-profile.png)
34+
![Terminal Profile](images/terminal-profile.png)
3535

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
3779

3880
This is an experimental tool currently in its Early Access Program (EAP). Your feedback is incredibly valuable for shaping its future.

images/command-palette.png

116 KB
Loading

images/terminal-profile.png

74.6 KB
Loading

images/usage.png

614 KB
Loading

0 commit comments

Comments
 (0)