Skip to content

Commit 79a4af6

Browse files
committed
update version, add note
1 parent aabdc36 commit 79a4af6

File tree

2 files changed

+26
-6
lines changed

2 files changed

+26
-6
lines changed

src/edgedb-cli/NOTES.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
## Note to Users
2+
3+
This feature mounts the edgedb config and data folder to the host machine for persistence. To do so, it makes some assumptions about `edgedb info`:
4+
5+
```bash
6+
$ edgedb info
7+
8+
EdgeDB uses the following local paths:
9+
┌────────────┬────────────────────────────────────────┐
10+
│ Cache │ /home/<user>/.cache/edgedb/ │
11+
│ Config │ /home/<user>/.config/edgedb/ │
12+
│ CLI Binary │ /home/<user>/.local/bin/edgedb │
13+
│ Data │ /home/<user>/.local/share/edgedb/data/ │
14+
│ Service │ /home/<user>/.config/systemd/user/ │
15+
└────────────┴────────────────────────────────────────┘
16+
```
17+
18+
**These paths may change based on the OS!**. This feature is tested on Ubuntu and Debian and the paths match up, but may not work for others.
19+
120
## OS and Architecture Support
221

322
Architectures: `amd` and `arm`
@@ -8,7 +27,8 @@ Shells: `bash`, `zsh`, `fish`
827

928
## Changelog
1029

11-
| Version | Notes |
12-
| ------- | ---------------------- |
13-
| 1.0.1 | Fix for non-root users |
14-
| 1.0.0 | Initial Version |
30+
| Version | Notes |
31+
| ------- | -------------------------- |
32+
| 1.0.2 | Cache edgedb config folder |
33+
| 1.0.1 | Fix for non-root users |
34+
| 1.0.0 | Initial Version |

src/edgedb-cli/devcontainer-feature.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"name": "EdgeDB",
33
"id": "edgedb-cli",
4-
"version": "1.0.1",
4+
"version": "1.0.2",
55
"documentationURL": "https://github.com/joshuanianji/devcontainer-features/tree/main/src/edgedb-cli",
6-
"description": "EdgeDB CLI via the official installation script. Includes the VSCode extension and mounts ~/.local/share/edgedb for data persistence.",
6+
"description": "EdgeDB CLI via the official installation script. Includes the VSCode extension and mounts the config and data folder.",
77
"options": {},
88
"customizations": {
99
"vscode": {

0 commit comments

Comments
 (0)