Fixes to the documentation. Added missing --revoked logic for the list command.
Some checks failed
Release / release (push) Failing after 53s
Some checks failed
Release / release (push) Failing after 53s
This commit is contained in:
13
README.md
13
README.md
@@ -86,7 +86,7 @@ lab-ca list --revoked
|
||||
Issue a new certificate from the command line:
|
||||
|
||||
```bash
|
||||
lab-ca issue --name <name> [--subject <subject>] [--type <type>] [--validity <period>] [--san <SAN> ...] [--overwrite] [--dry-run] [--verbose]
|
||||
lab-ca issue --name <name> [--subject <subject>] [--type <type>] [--validity <period>] [--san <SAN> ...] [--dry-run] [--verbose]
|
||||
```
|
||||
|
||||
- `--name` (required): Name for the certificate and key files (used as subject if `--subject` is omitted)
|
||||
@@ -94,7 +94,6 @@ lab-ca issue --name <name> [--subject <subject>] [--type <type>] [--validity <pe
|
||||
- `--type`: Certificate type: `client`, `server`, `code-signing`, `email` (comma-separated for multiple usages; default: `server`)
|
||||
- `--validity`: Validity period (e.g. `2y`, `6m`, `30d`; default: `1y`)
|
||||
- `--san`: Subject Alternative Name (repeatable; e.g. `dns:example.com`, `ip:1.2.3.4`, `email:user@example.com`)
|
||||
- `--overwrite`: Allow overwriting existing files
|
||||
- `--dry-run`: Validate and show what would be created, but do not write files
|
||||
- `--verbose`: Print detailed information
|
||||
|
||||
@@ -105,7 +104,7 @@ lab-ca issue --name <name> [--subject <subject>] [--type <type>] [--validity <pe
|
||||
Provision multiple certificates from a batch file (HCL):
|
||||
|
||||
```bash
|
||||
lab-ca provision --file <certificates.hcl> [--overwrite] [--verbose]
|
||||
lab-ca provision --file <certificates.hcl> [--verbose]
|
||||
```
|
||||
|
||||
#### Example HCL Provisioning File
|
||||
@@ -223,13 +222,9 @@ See `examples/example-certificates.hcl` for a more advanced provisioning file wi
|
||||
|
||||
## Building the Tool
|
||||
|
||||
The repository includes a `build.sh` script to build the CLI tool. It updates the version in `version.go` and builds the binary.
|
||||
The repository includes a `Makefile` to build the CLI tool. It automatically determines the version from Git tags and builds the binary.
|
||||
|
||||
To ignore changes made to `version.go` in Git, you can run:
|
||||
|
||||
```bash
|
||||
git update-index --assume-unchanged version.go
|
||||
```
|
||||
To build the tool, run the `make` command. The binary will be created as `build/lab-ca`.
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user