jx/README.md
Matthew Rich 4b172d0901
Some checks failed
Lint / golangci-lint (push) Failing after 9m59s
Declarative Tests / test (push) Failing after 1m0s
update readme
2024-03-27 13:10:32 -07:00

25 lines
653 B
Markdown

# decl
# Purpose
These tools work with YAML descriptions of resources (E.g. files, users, containers, etc) for (de)serializing the state of the given resource. This enables more generically describing the state of a supported resource type, pipeling state transformations and enabling the use of other tools in that process.
# Command-line
# Update Resource state
`cli -resource-file decl-runner.yaml`
# Read resource state
Read the state of an existing resource (URI) and generate a YAML representation of it.
![Import Resource](md-images/import-resource.gif)
# Examples
Resources:
* [file](examples/file.yaml)
* [user](examples/user.yaml)