From 9db8026274713df7c3525794a80d0c4df6c46a55 Mon Sep 17 00:00:00 2001 From: "Sachdeva, Kapil" Date: Sat, 10 Jan 2026 20:34:21 -0600 Subject: [PATCH 1/2] fix: typos in installation command for `brew` and `uv` --- src/content/docs/installation.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/content/docs/installation.mdx b/src/content/docs/installation.mdx index 259b37a..6a9291f 100644 --- a/src/content/docs/installation.mdx +++ b/src/content/docs/installation.mdx @@ -79,7 +79,7 @@ Now you can run Ladybug from the command line. You can install the Ladybug CLI using Homebrew. ```bash -brew install lbug +brew install ladybug ``` You can now run Ladybug from the command line. @@ -143,7 +143,7 @@ The instructions are the same for Linux, macOS, and Windows. ```bash uv init -uv add lbug +uv add real_ladybug ``` From f459af61924422438ade404377c124db19c4887b Mon Sep 17 00:00:00 2001 From: "Sachdeva, Kapil" Date: Sat, 10 Jan 2026 20:39:49 -0600 Subject: [PATCH 2/2] fix: typo in the name in the explorer docker image --- .../docs/visualization/lbug-explorer/index.mdx | 14 +++++++------- .../visualization/lbug-explorer/query-panel.md | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/content/docs/visualization/lbug-explorer/index.mdx b/src/content/docs/visualization/lbug-explorer/index.mdx index c663f16..9ab0551 100644 --- a/src/content/docs/visualization/lbug-explorer/index.mdx +++ b/src/content/docs/visualization/lbug-explorer/index.mdx @@ -36,7 +36,7 @@ To access an existing Ladybug database, you can mount its path to the `/database docker run -p 8000:8000 \ -v {path to the directory containing the database file}:/database \ -e LBUG_FILE={database file name} \ - --rm lbugdb/explorer:latest + --rm ghcr.io/ladybugdb/explorer:latest ``` By mounting a local database file in Docker via `-v {path to the directory containing the database file}` and `-e LBUG_FILE={database file name}`, the changes done in the UI will persist to the local database file after the UI is shutdown. If the directory is mounted but the `LBUG_FILE` environment variable is not set, Ladybug Explorer will look for a file named `database.kz` in the mounted directory or create it if missing. @@ -51,7 +51,7 @@ This is simply done by removing the `-v` flag in the example above. If no databa with `-v`, the server will be started with an empty database. ```bash -docker run -p 8000:8000 --rm lbugdb/explorer:latest +docker run -p 8000:8000 --rm ghcr.io/ladybugdb/explorer:latest ``` Click on the `Datasets` tab on the top right corner and then: (i) you can select one of the bundled datasets @@ -72,7 +72,7 @@ environment variable to `READ_ONLY` as shown below. docker run -p 8000:8000 \ -v /absolute/path/to/database:/database \ -e MODE=READ_ONLY \ - --rm lbugdb/explorer:latest + --rm ghcr.io/ladybugdb/explorer:latest ``` In read-only mode, you can still issue read queries (such as `MATCH`) and visualize the results, @@ -88,7 +88,7 @@ you can do so by setting the `LBUG_IN_MEMORY` environment variable to true as fo ```bash docker run -p 8000:8000 \ -e LBUG_IN_MEMORY=true \ - --rm lbugdb/explorer:latest + --rm ghcr.io/ladybugdb/explorer:latest ``` You can think of an in-memory database as ephemeral, where the database exists purely in memory -- @@ -110,7 +110,7 @@ For example, to launch Ladybug Explorer with a buffer pool size of 1GB, you can docker run -p 8000:8000 \ -v /absolute/path/to/database:/database \ -e LBUG_BUFFER_POOL_SIZE=1073741824 \ - --rm lbugdb/explorer:latest + --rm ghcr.io/ladybugdb/explorer:latest ``` #### Accessing data files in the container @@ -121,7 +121,7 @@ As mentioned above, Ladybug Explorer is launched from a Docker image. If you wan docker run -p 8000:8000 \ -v /absolute/path/to/database:/database \ -v /absolute/path/to/data:/data \ - --rm lbugdb/explorer:latest + --rm ghcr.io/ladybugdb/explorer:latest ``` With this configuration, the data directory you specify on your host machine will be accessible as `/data` in the container. For example, in the query panel, you can copy a CSV file into your database by running the following command: @@ -167,7 +167,7 @@ To install the dev build, you can attach the `dev` tag to the docker command as ```bash docker run -p 8000:8000 \ -v /absolute/path/to/database:/database \ - --rm lbugdb/explorer:dev + --rm ghcr.io/ladybugdb/explorer:dev ``` The dev build of Ladybug Explorer is compatible with the nightly build of Ladybug, but it's not guaranteed to be stable diff --git a/src/content/docs/visualization/lbug-explorer/query-panel.md b/src/content/docs/visualization/lbug-explorer/query-panel.md index d9896eb..92235cf 100644 --- a/src/content/docs/visualization/lbug-explorer/query-panel.md +++ b/src/content/docs/visualization/lbug-explorer/query-panel.md @@ -101,7 +101,7 @@ from within the Docker container that's running Ladybug Explorer. In Docker Desk Once this is enabled, you should be able to run the following command and then open `http://localhost:8000` as normal. ```bash # Run the following command to start Ladybug Explorer with host networking enabled -docker run --net=host --rm lbugdb/explorer:latest +docker run --net=host --rm ghcr.io/ladybugdb/explorer:latest ``` :::