Skip to content

docs: add Docker installation to READMEs#168

Merged
yimsk merged 2 commits intomainfrom
develop
Feb 23, 2026
Merged

docs: add Docker installation to READMEs#168
yimsk merged 2 commits intomainfrom
develop

Conversation

@yimsk
Copy link
Copy Markdown
Contributor

@yimsk yimsk commented Feb 23, 2026

Summary

  • Add Docker installation section to all READMEs (en, ja, zh-CN, ko)

@claude
Copy link
Copy Markdown

claude Bot commented Feb 23, 2026

PR Review: docs: add Docker installation to READMEs

This is a clean, straightforward documentation addition. The Docker command is technically correct and aligns well with the existing Dockerfile. A few observations:

Correctness ✓

  • The volume mount path /home/claws/.aws correctly matches the claws user home defined in the Dockerfile
  • The :ro (read-only) flag on the AWS credentials mount is good security practice
  • --rm and -it are the right flags for a TUI application
  • The image ghcr.io/clawscli/claws is correctly published via the docker.yml workflow with multi-arch support (amd64 + arm64)

Issues / Suggestions

Minor: Extra blank line in non-English READMEs

README.ja.md, README.ko.md, and README.zh-CN.md each have two blank lines before ### Docker, while README.md has one. This is a small inconsistency worth normalizing.

-
-
 ### Docker

Suggestion: Version-pinned example

Using ghcr.io/clawscli/claws without a tag pulls :latest, which can silently change. For a documentation snippet, consider showing both options or at least noting that users can pin a version:

docker run -it --rm \
  -v ~/.aws:/home/claws/.aws:ro \
  ghcr.io/clawscli/claws:latest   # or pin: ghcr.io/clawscli/claws:v1.2.3

Suggestion: Show how to pass claws flags

The Quick Start section (right below) shows profile/region flags like -p myprofile and -r us-west-2. It may help to include a brief example showing those still work with Docker:

docker run -it --rm \
  -v ~/.aws:/home/claws/.aws:ro \
  ghcr.io/clawscli/claws -p myprofile -r us-west-2

Suggestion: AWS environment variable alternative

Some users authenticate via environment variables rather than ~/.aws. A note or alternative example would make the Docker section complete for all credential setups:

docker run -it --rm \
  -e AWS_ACCESS_KEY_ID \
  -e AWS_SECRET_ACCESS_KEY \
  -e AWS_SESSION_TOKEN \
  ghcr.io/clawscli/claws

Summary

The core change is correct and a welcome addition. The extra blank line issue is a trivial fix. The other suggestions are optional improvements — feel free to leave them for a follow-up PR if you prefer to keep this focused.

@claude
Copy link
Copy Markdown

claude Bot commented Feb 23, 2026

PR Review: docs: add Docker installation to READMEs

Overall this is a clean, well-structured docs addition. The command is consistent across all four language READMEs, correctly uses ro for the AWS credentials mount, and -it --rm are the right flags for an interactive TUI container. A few observations:

Correctness

The volume mount path /home/claws/.aws correctly matches the Dockerfile's adduser -D -h /home/claws claws / USER claws setup — good catch.

Suggestions

1. No image tag specified

ghcr.io/clawscli/claws        # implicitly pulls :latest

latest is convenient but can silently change between runs. Consider either showing how to pin a version, or at least adding a note:

# pin to a specific release (recommended for reproducibility)
docker run -it --rm \
  -v ~/.aws:/home/claws/.aws:ro \
  ghcr.io/clawscli/claws:v0.x.y

2. Passing CLI arguments

The Quick Start section shows flags like -p, -r, and --read-only, but the Docker example doesn't hint that these work the same way. A one-liner note or example would help:

# Example: specify profile and region
docker run -it --rm \
  -v ~/.aws:/home/claws/.aws:ro \
  ghcr.io/clawscli/claws -p myprofile -r us-west-2

3. Users without a ~/.aws directory

Some users authenticate via environment variables (AWS_ACCESS_KEY_ID, AWS_SESSION_TOKEN, etc.) or rely on EC2/ECS IAM roles. A brief mention of the -e approach as an alternative would improve coverage:

docker run -it --rm \
  -e AWS_ACCESS_KEY_ID \
  -e AWS_SECRET_ACCESS_KEY \
  -e AWS_SESSION_TOKEN \
  ghcr.io/clawscli/claws

Minor

  • The section title ### Docker is consistent across all four files. ✓
  • Placement (after Go Install, before Quick Start) is logical. ✓
  • All four READMEs are updated identically. ✓

None of the above are blockers — the current command works correctly for the common case. The suggestions are enhancements to cover more user scenarios. Happy to approve as-is or with the additions if the maintainers agree they add value.

@yimsk yimsk merged commit f508583 into main Feb 23, 2026
12 checks passed
@yimsk yimsk mentioned this pull request Feb 24, 2026
tmeijn pushed a commit to tmeijn/dotfiles that referenced this pull request Feb 24, 2026
This MR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [github:clawscli/claws](https://github.com/clawscli/claws) | patch | `0.15.0` → `0.15.1` |

MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot).

**Proposed changes to behavior should be submitted there as MRs.**

---

### Release Notes

<details>
<summary>clawscli/claws (github:clawscli/claws)</summary>

### [`v0.15.1`](https://github.com/clawscli/claws/releases/tag/v0.15.1)

[Compare Source](clawscli/claws@v0.15.0...v0.15.1)

#### Changelog

- [`4fe75b6`](clawscli/claws@4fe75b6) Add docker support and github CR package workflow
- [`92189e5`](clawscli/claws@92189e5) Cross-compile for multiple archs instead of relying on QEMU
- [`63731ed`](clawscli/claws@63731ed) Merge pull request [#&#8203;165](clawscli/claws#165) from clawscli/develop
- [`d806a8e`](clawscli/claws@d806a8e) Merge pull request [#&#8203;167](clawscli/claws#167) from stefan-matic/main
- [`f508583`](clawscli/claws@f508583) Merge pull request [#&#8203;168](clawscli/claws#168) from clawscli/develop
- [`7fbf05d`](clawscli/claws@7fbf05d) Merge pull request [#&#8203;169](clawscli/claws#169) from dpalvolgyi-pw/feature/ecs-last-deployment
- [`87d9644`](clawscli/claws@87d9644) Merge pull request [#&#8203;170](clawscli/claws#170) from clawscli/develop
- [`6d22155`](clawscli/claws@6d22155) feat(ecs): add last deployment column

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever MR is behind base branch, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this MR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My4zMS4xIiwidXBkYXRlZEluVmVyIjoiNDMuMzEuMSIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiUmVub3ZhdGUgQm90IiwiYXV0b21hdGlvbjpib3QtYXV0aG9yZWQiLCJkZXBlbmRlbmN5LXR5cGU6OnBhdGNoIl19-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant