Skip to content

docs: add Windows devkit troubleshooting notes #3363

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

Open
amogh2222 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add Windows devkit troubleshooting notes #3363

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
23 changes: 23 additions & 0 deletions devkit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,3 +440,26 @@ my.node.label=node-${NODE_ID}
```bash
just start 1 my-feature
```

## Windows Troubleshooting

### Git Bash Path Issues

If `just start-build` fails on Windows Git Bash due to Docker path conversion issues, try:

```bash
export AUTOMQ_DEV_HOME=/c/automq/devkit
docker compose up -d
```

Alternatively, running Docker Compose directly may work better than `just start-build` on Windows environments.

### Docker Engine Errors

If Docker commands fail with:

```text
failed to connect to the docker API
```

Restart Docker Desktop and verify the engine is running before starting the devkit.
Loading