ruanzhu-kit CLI
A CLI that prepares China software copyright materials: a source PDF with an exact page count and an online form checklist.
- 112 ★ on the repository
- Last commit
- MIT
Extended access
Why this level
- The tool reads the project source code and writes PDF and `.doc` files into the `ruanzhu/` directory.
- Chrome runs in headless mode for rendering.
Install
- Works in
Manual install
npx github:CatCatUncle/ruanzhu-kit initThe first README command: creates `ruanzhu.config.json` and a manual skeleton.
Access and checks
How we reviewExtended accessThe tool runs code or makes network calls and only reads external data.
- The tool reads the project source code and writes PDF and `.doc` files into the `ruanzhu/` directory.
- Chrome runs in headless mode for rendering.
This is third-party code. Review the repository files before installing.
What it does
ruanzhu-kit is a plain Node.js CLI for preparing software copyright registration materials in China. From a source tree it produces a source-code PDF with pages computed before rendering, a user manual PDF from the `说明书.md` file and a checklist for the online form fields. If the code runs past 60 pages, the first and last 30 are taken with an explanatory page between them stating the number of omitted lines: 62 pages in all. The `ruanzhu init` command creates a config and a manual skeleton, `count` shows which files were included and how many lines they hold, and `source`, `manual`, `form` and `all` build the materials. After generation the tool re-reads the PDF and checks the page count, the cover and the explanatory page. A human writes the manual and the form texts about purpose, industry, functions and features: the project does not generate them.
Who it is for. Developers and companies registering copyright for their program in China who lose time laying out materials in Word by hand.
Good fit when
- Source code runs past 60 pages and the first and last 30 are needed.
- A PDF from Word comes out at different lengths on different machines.
- Before submission the count is checked for stray files: dependencies and build artifacts.
- An agent prepares materials through `SKILL.md` while a human writes the descriptions.
- Online form fields are checked for length and boilerplate phrases.
Not a fit when
- Registration happens outside China.
- The program was built with AI help: the project authors advise not signing the no-AI declaration and consulting the copyright protection centre or a lawyer first.
- Legal advice and ownership documents are needed: the tool does not prepare them.
Example request
Run `ruanzhu count` to see which files enter the materials and show suspicious ones to move into `exclude`.Limitations
Node.js 18 or newer and Chrome, Chromium or Edge version 131 and above are required for headers; the browser path is set with `CHROME_PATH`. A human fills in the manual and the form fields: the project warns that AI texts often describe functions that do not exist and lead to rejection. Applicant documents and ownership certificates are not prepared by the tool. The main documentation is in Chinese; an English version lives in `README_EN.md`.
How to disable. Delete the `ruanzhu/` directory with config and output from the project. If you installed through `npm link`, remove the link with `npm unlink`.
FAQ
How do I run ruanzhu-kit?
In the project directory run `npx github:CatCatUncle/ruanzhu-kit init`, fill in `ruanzhu.config.json` and run `ruanzhu count`. Node.js 18 or newer and Chrome 131 or newer are required.
How many pages does the final PDF have?
Exactly 62 for code longer than 60 pages: cover, first 30 pages, an explanatory page and the last 30. The count is computed before rendering and verified by re-reading the PDF.
Why run the `count` command?
It shows which files were included and their line counts, putting suspicious ones on top. Extra lines from build artifacts often lead to rejection, so such files go into `exclude` or `excludeFiles`.
Does AI write the descriptions and form fields?
No. The CLI calls no models. A human writes the manual and form fields while the tool counts field length and flags boilerplate phrases.
Does ruanzhu-kit work as a skill?
Yes, the repository has `SKILL.md` and an agent can run the commands. For platforms with two-level nesting, `npm run pack:skill` builds the archive.
Discussion
No questions or reviews yet.
Related
CLI toolsA skill reads a project and builds materials for registering software in China: code, manual and form data, then helps submit.
A skill for Chinese technical docs: short sentences, facts over adjectives and a 14-item check for AI tells
A skill for Chinese technical writing: rewrites docs, interface strings and API descriptions, keeps the facts intact and checks output with a linter
A set of LaTeX templates for Chinese research documents paired with Claude Code and Codex skills that fill and verify them
Quarto is a CLI for scientific publishing, combining text, computations and figures into reports, books, websites or slides.
ReadmeAI analyzes repository files and drafts a README with a project overview, directory structure and setup guidance.
README in short
Compared with manual layout in Word, the tool fixes pages before rendering, adds headers and page numbers, counts characters in form fields and pre-fills six development and runtime environment fields from the machine configuration.