{"id":43533992,"url":"https://github.com/jacekzwpl/docueye","last_synced_at":"2026-02-03T16:23:34.644Z","repository":{"id":219474919,"uuid":"749046403","full_name":"jacekzwpl/docueye","owner":"jacekzwpl","description":"DocuEye is a tool that lets You visualize views and documentation created using Structurizr DSL","archived":false,"fork":false,"pushed_at":"2026-01-27T17:57:00.000Z","size":3462,"stargazers_count":15,"open_issues_count":7,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-01-28T03:55:58.323Z","etag":null,"topics":["architecture","c4model","documentation","structurizr"],"latest_commit_sha":null,"homepage":"https://docueye.com","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jacekzwpl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-01-27T12:35:32.000Z","updated_at":"2026-01-27T17:48:15.000Z","dependencies_parsed_at":"2024-02-21T19:26:24.409Z","dependency_job_id":"77335207-9cbf-4fd3-b832-86ce55a4b158","html_url":"https://github.com/jacekzwpl/docueye","commit_stats":null,"previous_names":["jacekzwpl/docueye"],"tags_count":22,"template":false,"template_full_name":null,"purl":"pkg:github/jacekzwpl/docueye","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacekzwpl%2Fdocueye","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacekzwpl%2Fdocueye/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacekzwpl%2Fdocueye/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacekzwpl%2Fdocueye/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jacekzwpl","download_url":"https://codeload.github.com/jacekzwpl/docueye/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacekzwpl%2Fdocueye/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29048715,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-03T15:43:47.601Z","status":"ssl_error","status_checked_at":"2026-02-03T15:43:46.709Z","response_time":96,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["architecture","c4model","documentation","structurizr"],"created_at":"2026-02-03T16:23:30.597Z","updated_at":"2026-02-03T16:23:34.631Z","avatar_url":"https://github.com/jacekzwpl.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DocuEye\r\nDocuEye is a tool that lets You visualize views and documentation created using [Structurizr DSL](https://structurizr.com/).  \r\nCurrently there is no demo but you can see [DocuEye product page](https://docueye.com) to see some screenshots and features description. \r\n\r\n## Features\r\n- Import workspace via REST API\r\n- Dedicated CLI\r\n- Diagram viewer - You can view all diagrams in nice user friendly way (in my opinion :))\r\n    - Automatic layout\r\n    - Manual move elements\r\n    - Diagram navigation\r\n    - Export to PNG\r\n- Graph viewer - You can view diagrams as graphs\r\n    - Focusing on selected node\r\n- Elements catalog - You can search, navigate through your model elements \r\n    - View element properties. [See extra DocueEye properties](Documentation/docs/0003-element-extra-properties.md)\r\n    - View element dependencies\r\n    - View element consumers\r\n    - View element children\r\n    - View element documentation\r\n    - View element decisions\r\n    - Import and view element openapi specification\r\n- Decisions viewer - You can view all decisions defined at workspace or element level\r\n- Documentation viewer - You can view documentation defined at workspace or element level\r\n- Change Tracker - DocuEye tracks changes in the model on every import. You can view history of changes in Your model. [See what to do to change tracker works as expected](Documentation/docs/0001-change-tracker.md)  \r\n- Deployment Nodes Matrix - You can view relationships between deployment nodes that implies from relationships between deployed model elements.\r\n- OIDC Integration. [See how to integrate with OIDC provider](Documentation/docs/0008-oidc-integration.md).\r\n\r\nSee [features roadmap](Documentation/docs/0002-features-roadmap.md) if You want to know what features will be implemented in nearest feature.\r\n\r\n## Getting started\r\n\r\nThe best way to get start is to use docker image.  \r\nTo run DocuEye You can use docker compose. File used in this example can be found [here](docker-compose.yml). Description of configuration options can be found [here](Documentation/docs/0004-configuration.md)  \r\nDocuEye use Mongo DB as persistence so You need two containers running at one time.  \r\n\r\n```Powershell\r\ndocker compose up -d\r\n```\r\nThats it :). If everything goes es expected You can now access DocuEye at http://localhost:8080  \r\nIf You manage to run application You can see empty workspaces list.  \r\n\r\nSo it's time to import one.  \r\n\r\n```Powershell\r\ncd .\\ExampleWorkspace\r\n\r\ndocker run -it --rm --network=\"host\" -v \"$($PWD):/app/import\" jacekzwpl/docueye-cli workspace import --docueye-address=http://localhost:8080 --admin-token=docueyedmintoken --key=\"$((New-Guid).Guid)\" --id=638d0822-12c7-4998-8647-9c7af7ad2989 --file=./import/workspace.dsl\r\n# In this example $PWD is current directory path. \r\n```\r\n\r\nDocueEye CLI is also distributed as dotnet tool via [nuget package](https://www.nuget.org/packages/DocuEye.CLI/) - current version requires .net 10 to be preinstalled.\r\nInstalling DocuEye CLI \r\n```Powershell\r\ndotnet tool install --global DocuEye.CLI\r\n```\r\nImport workspace using command line \r\n```Powershell\r\ncd .\\ExampleWorkspace\r\n\r\ndocueye workspace import --docueye-address=http://localhost:8080 --admin-token=docueyedmintoken --key=\"$((New-Guid).Guid)\" --id=638d0822-12c7-4998-8647-9c7af7ad2989 --file=workspace.dsl\r\n```\r\nExample script to import workspace can be found [here](ExampleWorkspace/import.ps1).  \r\n\r\nOnce we imported our workspace we can also import openapi specification for model elements.  \r\nExample script can be found  [here](ExampleWorkspace/import-openapi.ps1).\r\n  \r\n\r\n  \r\nYou can read about all options for DocuEye CLI [here](Documentation/docs/0005-docueye-cli.md).  \r\nYou can also use --help switch to see available options.  \r\nFor docker image  \r\n```\r\ndocker run -it --rm jacekzwpl/docueye-cli --help\r\n```\r\nFor command line \r\n```\r\ndocueye --help\r\n```\r\n\r\n\r\n\r\n\r\n\r\n## Contributing\r\nI welcome all contributors. But before making PR-s start with create issue that we can discuss the change.\r\n\r\n\r\n\r\n\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjacekzwpl%2Fdocueye","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjacekzwpl%2Fdocueye","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjacekzwpl%2Fdocueye/lists"}