jhl-labs/docs-cli Action

Install docs-cli from jhl-labs/dist and run a standardized-docs command (init, generate, validate, render) with GitHub Actions annotations.

View on GitHub

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Activelast commit Jun 9, 2026
License: None

Pinned Snippet

workflow.ymlSHA-pinned

uses: jhl-labs/docs-cli-action@ba2adc772587f724f74439a198f39c10006f1d84 # no releases — HEAD as of 2026-07-11

tags can be moved; commit SHAs can't. why a SHA?

Inputs

name	description	required	default
token	GitHub token used by checkout and docs-cli installation.	no	${{ github.token }}
checkout	Whether this action should checkout the repository before running.	no	true
repository	Repository to checkout.	no	${{ github.repository }}
ref	Git ref to checkout.	no	${{ github.ref }}
fetch-depth	Checkout fetch depth.	no	0
version	docs-cli version to install, such as v0.1.0. Use latest for the newest public release.	no	latest
command	docs-cli command to run (init\|generate\|validate\|render).	no	validate
target	Project path passed to docs-cli.	no	.
agent	AI agent for the generate command (claude\|codex\|gemini\|opencode\|none).	no	none
formats	Comma-separated render formats (html,xml).	no	html,xml
output-dir	Output directory override passed to docs-cli (empty uses the docs-cli default).	no	""
strict	Treat validation warnings as failures.	no	false
annotations	Emit GitHub Actions annotations from docs-cli validate findings.	no	true
annotation-limit	Maximum number of GitHub Actions annotations to emit.	no	200
fail-on-validation	Return the docs-cli exit code after annotations are emitted.	no	true
usage-tracking	Send usage metrics to SE Actions Space. Requires SE_ACTIONS_API_KEY in the caller environment.	no	true
usage-action-slug	Action slug registered in SE Actions Space for usage metrics.	no	docs-cli-action
se-actions-base-url	SE Actions Space base URL used for usage metrics.	no	https://actions.euno.work
se-actions-origin-ip	Optional origin IP used to bypass an external proxy for usage metrics smoke tests.	no	""
extra-args	Extra arguments appended to the docs-cli command.	no	""

Outputs

name	description
exit-code	docs-cli exit code.
duration-seconds	docs-cli execution duration in seconds.