README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

<h1 align="center"> Continue </h1>

<div align="center">

**[Continue](https://continue.dev/docs) is the open-source library for accelerating software development with language models**

</div>

<div align="center">

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
![GitHub issues](https://img.shields.io/github/issues-raw/continuedev/continue)
![GitHub Repo stars](https://img.shields.io/github/stars/continuedev/continue?style=social)
![Twitter URL](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fcontinuedev%2Fcontinue)

</div>

## Getting Started

### GitHub Codespaces

Learn how to try the GitHub Codespaces Demo [here](https://continue.dev/docs/getting-started)

### VS Code

Learn how to install locally in VS Code [here](https://continue.dev/docs/install)

## Walkthroughs

- [Use the GUI](https://continue.dev/walkthroughs/use-the-gui.md)
- [Use a recipe](https://continue.dev/walkthroughs/use-a-recipe.md)
- [Create a recipe](https://continue.dev/walkthroughs/create-a-recipe.md)
- [Share a recipe](https://continue.dev/walkthroughs/share-a-recipe.md)

## How to contribute

### Option 1: Create a recipe and share it with the community

Follow [these steps](https://continue.dev/walkthroughs/share-a-recipe.md) to share a recipe you have created :)

### Option 2: Open a [new GitHub Issue](https://github.com/continuedev/continue/issues/new) or comment on [an existing one](https://github.com/continuedev/continue/issues)

Let us know what you would like to contribute and we will help you make it happen!

## Install from source

#### 1. Clone this repo

Reccommended: Run this command to use SSH
```bash
git clone git@github.com:continuedev/continue.git
```

Alternative: Run this command to use HTTPS
```bash
git clone https://github.com/continuedev/continue
```

#### 2. Install Continue

Run this command to use the install script
```bash
cd continue/extension/scripts && python3 install_from_source.py
```

# Understanding the codebase

- [Continue Server README](./continuedev): learn about the core of Continue, which can be downloaded as a [PyPI package](https://pypi.org/project/continuedev/)
- [VS Code Extension README](./extension/src): learn about the capabilities of our extension—the first implementation of Continue's IDE Protocol—which makes it possible to use use Continue in VS Code and GitHub Codespaces
- [Continue GUI README](./extension/react-app/): learn about the React app that lets users interact with the server and is placed adjacent to the text editor in any suppported IDE
- [Schema README](./schema): learn about the JSON Schema types generated from Pydantic models, which we use across the `continuedev/` and `extension/` directories
- [Continue Docs README](./docs): learn how our [docs](https://continue.dev/docs) are written and built

# License

[Apache 2.0 © 2023 Continue Dev, Inc.](./LICENSE)