jx/README.md

# 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.

# Dependencies

* Go >= 1.21.1

# Testing

Testing the current version involves checking out main and building.

```
git clone https://gitea.rosskeen.house/Declarative/decl.git

make test

make build
```

# Command-line

# Update Resource state

`decl -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) [schema](internal/resource/schemas/file.jsonschema)
* [user](examples/user.yaml) [schema](internal/resource/schemas/user.jsonschema)
* [package](examples/package.yaml) [schema](internal/resource/schemas/package.jsonschema)
* [container](examples/container.yaml) [schema](internal/resource/schemas/container.jsonschema)
* [network_route](examples/network_route.yaml) [schema](internal/resource/schemas/network_route.jsonschema)
Initial commit 2024-03-09 00:12:54 +00:00			`# decl`

update readme 2024-03-27 20:10:32 +00:00			`# 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.`
add env vars to container resource 2024-03-21 22:28:29 +00:00
update readme with testing steps 2024-03-27 23:08:13 +00:00			`# Dependencies`

			`* Go >= 1.21.1`

			`# Testing`

			`Testing the current version involves checking out main and building.`

fix code block formatting 2024-03-27 23:09:18 +00:00			```
			`git clone https://gitea.rosskeen.house/Declarative/decl.git`
update readme with testing steps 2024-03-27 23:08:13 +00:00
			`make test`

			`make build`
fix code block formatting 2024-03-27 23:09:18 +00:00			```
update readme with testing steps 2024-03-27 23:08:13 +00:00
add env vars to container resource 2024-03-21 22:28:29 +00:00			`# Command-line`

update readme 2024-03-27 19:25:12 +00:00			`# Update Resource state`

fix linting errors 2024-04-03 19:27:16 +00:00			`decl -resource-file decl-runner.yaml`
add env vars to container resource 2024-03-21 22:28:29 +00:00
update readme 2024-03-27 19:25:12 +00:00			`# Read resource state`

update readme 2024-03-27 20:03:28 +00:00			`Read the state of an existing resource (URI) and generate a YAML representation of it.`

add screencast for import-resource 2024-03-26 08:08:59 +00:00			`![Import Resource](md-images/import-resource.gif)`

add some example documents 2024-03-25 21:57:30 +00:00			`# Examples`
add env vars to container resource 2024-03-21 22:28:29 +00:00
add some example documents 2024-03-25 21:57:30 +00:00			`Resources:`

fix schema path 2024-04-03 19:48:30 +00:00			`* [file](examples/file.yaml) [schema](internal/resource/schemas/file.jsonschema)`
			`* [user](examples/user.yaml) [schema](internal/resource/schemas/user.jsonschema)`
			`* [package](examples/package.yaml) [schema](internal/resource/schemas/package.jsonschema)`
			`* [container](examples/container.yaml) [schema](internal/resource/schemas/container.jsonschema)`
			`* [network_route](examples/network_route.yaml) [schema](internal/resource/schemas/network_route.jsonschema)`