Skip to content

Commit

Permalink
More info about CODY_PATH on Contributing.md (#1896)
Browse files Browse the repository at this point in the history 
Adds absolute path detail about CODY_DIR

## Test plan

Previewed with GitHub Preview
  • Loading branch information
@danielmarquespt
danielmarquespt authored Jul 9, 2024
1 parent fc8351a commit 417dd04
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,19 @@ our [issue tracker](https://github.com/sourcegraph/cody/issues/new/choose).

### Running

| What | Command |
|------------------------------------------------------------------|--------------------------------------------------------------------------|
| Run the plugin locally | `./gradlew :runIde` |
| Run the plugin locally with fresh build of Cody | `./gradlew -PforceAgentBuild=true :runIde` |
| Run the plugin locally with fresh build of a local clone of Cody | `CODY_DIR=<path_to_cody> ./gradlew -PforceAgentBuild=true :runIde` |
| Run the plugin locally with fresh build of Code Search assets | `./gradlew -PforceCodeSearchBuild=true :runIde` |
| Run the plugin locally with different IntelliJ version | `./gradlew -PplatformVersion=2023.1 :runIde` |
| Build Code Search assets (separate terminal) | `pnpm build` |
| Continuously re-build Code Search assets (separate terminal) | `pnpm watch` |
| Code Search "Find with Sourcegraph" window | `pnpm standalone && open http://localhost:3000/` |
| Build deployable plugin | `./gradlew buildPlugin` (artifact is generated in `build/distributions`) |
| Reformat Java and Kotlin sources | `./gradlew spotlessApply` |
| Debug agent JSON-RPC communication | `tail -f build/sourcegraph/cody-agent-trace.json` |
| What | Command |
|-------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------|
| Run the plugin locally | `./gradlew :runIde` |
| Run the plugin locally with fresh build of Cody | `./gradlew -PforceAgentBuild=true :runIde` |
| Run the plugin locally with fresh build of a local clone of Cody (CODY_DIR needs to be an absolute path) | `CODY_DIR=<path_to_cody> ./gradlew -PforceAgentBuild=true :runIde` |
| Run the plugin locally with fresh build of Code Search assets | `./gradlew -PforceCodeSearchBuild=true :runIde` |
| Run the plugin locally with different IntelliJ version | `./gradlew -PplatformVersion=2023.1 :runIde` |
| Build Code Search assets (separate terminal) | `pnpm build` |
| Continuously re-build Code Search assets (separate terminal) | `pnpm watch` |
| Code Search "Find with Sourcegraph" window | `pnpm standalone && open http://localhost:3000/` |
| Build deployable plugin | `./gradlew buildPlugin` (artifact is generated in `build/distributions`) |
| Reformat Java and Kotlin sources | `./gradlew spotlessApply` |
| Debug agent JSON-RPC communication | `tail -f build/sourcegraph/cody-agent-trace.json` |

### Editor config

Expand Down

0 comments on commit 417dd04

Please sign in to comment.