Skip to content

Commit e4cd46f

Browse files
authored
docs: mention cursor (#4353)
1 parent a6cbaa1 commit e4cd46f

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/development/getting-started.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@ alembic -c keep/alembic.ini revision --autogenerate -m "Your message"
8383

8484
Hint: make sure your models are imported at `./api/models/db/migrations/env.py` for autogenerator to pick them up.
8585

86-
## VSCode
87-
You can run Keep from your VSCode (after cloning the repo) by adding this configurations to your `.vscode/launch.json`:
86+
## VS Code (or Cursor)
87+
Run Keep from your VS Code (or Cursor) after cloning the repo by adding this configurations to your `.vscode/launch.json`:
8888

8989
```json
9090
{
@@ -158,21 +158,21 @@ docker run -d -p 6001:6001 -p 9601:9601 -e SOKETI_USER_AUTHENTICATION_TIMEOUT=30
158158
```
159159

160160

161-
## VSCode + Docker
162-
<Info>For this guide to work, the VSCode Docker extension is required.</Info>
161+
## VS Code (or Cursor) + Docker
162+
<Info>For this guide to work, the [VS Code Docker](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) extension is required.</Info>
163163
<Tip>In air-gapped environments, you might consider building the container on an internet-connected computer, exporting the image using docker save, transferring it with docker load in the air-gapped environment, and then using the run configuration.</Tip>
164164

165-
In cases where you want to develop Keep but are unable to run it directly on your local laptop (e.g., with Windows), or if you lack access to all of its dependencies (e.g., in air-gapped environments), you can still accomplish this using VSCode and Docker.
165+
In cases where you want to develop Keep but are unable to run it directly on your local laptop (e.g., with Windows), or if you lack access to all of its dependencies (e.g., in air-gapped environments), you can still accomplish this using VS Code (or Cursor) and Docker.
166166

167167
To achieve this, follow these steps:
168168

169-
1. Clone Keep and open it with VSCode
169+
1. Clone Keep and open it with VS Code (or Cursor)
170170
2. Create a tasks.json file to build and run the Keep API and Keep UI containers.
171171
3. Create a launch.json configuration to start the containers and attach a debugger to them.
172172
4. Profit.
173173

174174

175-
### Clone Keep and open it with VSCode
175+
### Clone Keep and open it with VS Code (or Cursor)
176176
```
177177
git clone https://github.com/keephq/keep.git && cd keep
178178
code .

0 commit comments

Comments
 (0)