anthropics / anthropics/claude-code
Feature request: ship a man page for the claude CLI
- Ngôn ngữ chính
- Python
- Star
- 145k
- Fork
- 23.1k
- Chỉ số merge pull request
- Chỉ số pull request đang chờ
Mô tả
Claude Code is distributed via npm, and npm-installed CLIs generally don't get a man page installed alongside them the way a deb/rpm/Homebrew formula would — there's no `claude(1)` today, only `claude --help`.
I put together a draft man page (scdoc format, compiles clean with `scdoc`/`groff`, renders correctly via `man -l`) with the goal of eventually packaging it for Arch Linux (AUR) so `man claude` works after install: https://github.com/webdawg/claude-code-man-page
It transcribes the current `--help` output into standard man page sections (SYNOPSIS/OPTIONS/COMMANDS/EXAMPLES/ENVIRONMENT/etc.), plus a WARNING section placed right after SYNOPSIS covering the flags that bypass permission checks or load external configuration (`--dangerously-skip-permissions`, `--allow-dangerously-skip-permissions`, `--permission-mode bypassPermissions`, `--mcp-config`/`--plugin-dir`/`--plugin-url`/`--settings`), since those are easy to underestimate from a one-line `--help` description.
Filing this as an issue rather than a PR since the CLI itself is closed-source and I don't know if `claude-code` (this repo) is the right place for a man page to live, or whether it'd need to ship from the npm package / native installer instead. A few questions:
- Is there interest in an official man page at all, vs. this staying a third-party project?
- If so, would it make more sense maintained here, in the npm package itself, or left to distro packagers (Arch/Debian/Homebrew) to write and maintain independently?
- Either way, happy to keep the draft above up to date and hand it off if useful.
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Hướng nghiên cứu
Review the linked scdoc draft and the CLI's current --help output first. Decide whether the official source should live in this repository, the npm package, or distro packaging, then confirm the supported distribution path and ownership; done means an agreed home and maintenance plan for an official claude(1) page.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- arch-linux, node.js
- Lĩnh vực
- cli, documentation, release
- Loại issue
- Tài liệu
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Sôi nổi
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 35/100