You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To get a local development build of Convex you need [git](https://git-scm.com/) and [Apache Maven](https://maven.apache.org/). You will also need a recent version of Java ([JDK 21+ recommended](https://www.oracle.com/java/technologies/downloads/), though anything from 17 onwards should be supported)
72
+
To get a local development build of Convex you need [git](https://git-scm.com/) and [Apache Maven](https://maven.apache.org/). You will also need a recent version of Java ([JDK 21+ recommended](https://www.oracle.com/java/technologies/downloads/).
67
73
68
74
1. Clone [this repository](https://github.com/Convex-Dev/convex) using `git` - you probably want the `develop` branch (the default)
69
75
2. Build using `mvn install` in the root directory
70
76
71
77
This should download all necessary dependencies and perform a standard build.
72
78
73
-
### Convex Desktop
79
+
### Running Convex Desktop
74
80
75
-
Convex Desktop is a GUI application for power users and developers providing full access to the capabilities of Convex. To run, you will need a modern version of Java installed (21+) and the `convex-desktop.jar` executable file (which can be found in the outputs of the Maven build above, or downloaded from trusted sources).
81
+
Convex Desktop is a GUI application for power users and developers providing full access to the capabilities of Convex. To run, you will need a modern version of Java installed (21+) and the `convex.jar` executable file (which can be found in the outputs of the Maven build above, or downloaded from trusted sources).
82
+
83
+
If Java is correctly installed, you should be able to double-click the executable `convex.jar` file to run it. Depending on your security settings, you may need to grant approval for this to run.
84
+
85
+
Alternatively, run Convex Desktop using `java` at the command line as follows:
76
86
77
87
```bash
78
-
java -jar convex-desktop.jar
88
+
java -jar convex.jar desktop
79
89
```
80
90
81
-
### Command Line Interface (CLI)
91
+
### Running the Convex Command Line Interface (CLI)
82
92
83
-
If you have an already built version of the Convex CLI `convex-cli.jar` file and installed a recent version of Java you can run it as follows:
93
+
If you have an already built version of the Convex CLI `convex.jar` file and installed a recent version of Java you can run it as follows:
84
94
85
95
```bash
86
-
java -jar convex-cli.jar <optional args>
96
+
java -jar convex.jar <optional args>
87
97
```
88
98
89
99
For convenience, there are shell scripts to automate this for common platforms in the root directory of this repo, e.g.
90
100
91
101
```bash
92
102
./convex --help
93
103
```
104
+
94
105
Using the CLI, you can start the Convex Desktop GUI for a local peer test network by using the `local gui` command:
0 commit comments