https://github.com/owulveryck/cue4puml4c4

POC to turn cue into a plantuml/C4 diagram
https://github.com/owulveryck/cue4puml4c4

c4 c4model cue cuelang hacktoberfest plantuml

Last synced: 23 days ago
JSON representation

POC to turn cue into a plantuml/C4 diagram

• Host: GitHub
• URL: https://github.com/owulveryck/cue4puml4c4
• Owner: owulveryck
• Created: 2022-03-03T14:48:51.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-19T08:39:12.000Z (5 months ago)
• Last Synced: 2024-08-03T01:12:51.347Z (3 months ago)
• Topics: c4, c4model, cue, cuelang, hacktoberfest, plantuml
• Language: CUE
• Homepage:
• Size: 399 KB
• Stars: 19
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-cue - cue4puml4c4 - POC to turn CUE into a plantuml/C4 diagram. (Projects)

README

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