Skip to content

docs: update dawgrun readme #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seanjSO merged 1 commit into from
Aug 7, 2026
Merged

docs: update dawgrun readme #113

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 20 additions & 9 deletions tools/dawgrun/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,19 +35,13 @@ connection.

## Building

From a `DAWGS` checkout:
From a `DAWGS` checkout, run the tool directly:

go tool dawgrun

With a customized `DAWGS` clone, for testing features, version differences, etc:
To build a local binary instead:

cd tools/dawgrun
just build-with-dawgs path/to/DAWGS

To switch the build back to mainline:

cd tools/dawgrun
just build-with-upstream
go build -o tools/dawgrun/dawgrun ./tools/dawgrun/cmd/dawgrun
Comment on lines +38 to +44

@coderabbitai coderabbitai Bot Aug 6, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Use fenced code blocks for the new shell commands.

markdownlint-cli2 reports MD046 at Lines 40, 44, 297, and 301. Convert all four indented command examples to fenced code blocks so the README passes the configured Markdown lint check.

Also applies to: 294-301

🧰 Tools
🪛 markdownlint-cli2 (0.23.2)

[warning] 40-40: Code block style
Expected: fenced; Actual: indented

(MD046, code-block-style)

[warning] 44-44: Code block style
Expected: fenced; Actual: indented

(MD046, code-block-style)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@tools/dawgrun/README.md` around lines 38 - 44, Update the command examples
around “go tool dawgrun” and the local binary build, including the corresponding
examples near the later referenced section, from indented Markdown blocks to
fenced shell code blocks. Convert all four command examples while preserving
their commands and surrounding text so markdownlint MD046 passes.

Source: Linters/SAST tools


## Running

Expand Down Expand Up @@ -288,3 +282,20 @@ the `DAWGRUN_STYLE` environment variable.
Any styles in [Chroma](https://github.com/alecthomas/chroma/tree/master/styles) are available for use as a syntax highlighting style.
CLI mode disables all terminal styling, including syntax highlighting
and styled warnings, when stdout is not a terminal.

## Common Issues

### Why does opening a new Postgres database fail with `open failed: could not set default graph: no rows in result set`?

`open` selects the configured default graph, which is named `default`
unless `-default-graph` is provided. A new Postgres database may have a
DAWGS schema but no graph row yet, so selecting that default graph fails.

For a database that should be initialized for dawgrun, open it with
`-init-graph`:

dawgrun > open -init-graph local "postgres://postgres:password@localhost:32771/"

If you use a non-default graph name, pass it with `-default-graph`:

dawgrun > open -init-graph -default-graph mygraph local "postgres://postgres:password@localhost:32771/"
Loading