Skip to content

Commit 4480629

Browse files
committed
add usage notes
1 parent fad0fc9 commit 4480629

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/edgedb-cli/NOTES.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
1+
## Usage
12

3+
**The EdgeDB instance should not be in the same container as the CLI.** My experience doing so makes the `edgedb ui` command start failing once you restart the container. I recommend the following options:
4+
5+
1. Use a docker-compose template with two services: one for the CLI and one for the EdgeDB instance.
6+
7+
You can either use the [javascript-node-edgedb](https://github.com/joshuanianji/devcontainer-templates/blob/main/src/javascript-node-edgedb) or the [rust-edgedb](https://github.com/joshuanianji/devcontainer-templates/blob/main/src/rust-edgedb) templates, or use them as references to make your own.
8+
9+
Once inside the devcontainer, you can run `edgedb instance link` to connect the CLI to the instance. Check the templates above for more details.
10+
11+
2. Connect to a cloud instance [with `edgedb cloud`](https://docs.edgedb.com/cloud/cli).
212

313
## Notes on Volume Mounts
414

0 commit comments

Comments
 (0)