cue4puml4c4

KO | EN

gitlite — search

#python #typescript #llm #golang #go #android #machine-learning #rust #nodejs #awesome #kubernetes #awesome-list #openai #open-source

(★ 23)

POC to turn cue into a plantuml/C4 diagram

cue4puml4c4 Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# cue4puml4c4

For more information, please refer to [The Website](https://owulveryck.github.io/cue4puml4c4/)

## Pure cue

- clone the repo
- in `example` dir, tweak `example1.cue`
- `cue vet` to check... and `cue genpuml` to generate the plantuml

## live view

- Be sure to have a plantuml server running at `localhost:8080`.
- within the `example` dir
- Run the local server: `go run ../cmd`
- open a browser to [http://localhost:9090](http://localhost:9090)
- save a file in the current directory
- profit :D

## Simple HOWTO

### Create your own diagrams

```shell
$ mkdir $TMPDIR/mydir && cd $TMPDIR/mydir // obviously change this to something suitable for you
$ cue mod init
$ mkdir -p cue.mod/pkg/github.com/owulveryck/cue4puml4c4
$ git clone https://github.com/owulveryck/cue4puml4c4.git cue.mod/pkg/github.com/owulveryck/cue4puml4c4
$ cat <<EOF > test.cue
package main

import "github.com/owulveryck/cue4puml4c4:c4"

C1: c4.#C1 & { // the name C1 should be coherent with the name you declare in the command
        Systems: [{id: "sample", label: "my sample"}]
}
EOF

$ cat <<EOF > command_tool.cue
package main

import (
        "tool/cli"
        "text/template"
        "github.com/owulveryck/cue4puml4c4:c4"
)

command: genpuml: {
        c1: cli.Print & {
                text: template.Execute(c4.plantumlTemplate, C1) // change C1 here with the name of your object
        }
}
EOF

$ cue genpuml
```

### Live preview

*Prerequisites:*

- Go
- a running plantuml server
- run the following command:

```shell
cd ./cue.mod/pkg/github.com/owulveryck/cue4puml4c4/cmd/
./cue.mod/pkg/github.com/owulveryck/cue4puml4c4/cmd/cmd
```

open your browser to [localhost:9090](http://localhost:9090)

cue4puml4c4

cue4puml4c4 Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

cue4puml4c4

cue4puml4c4 Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README