{"id":13847386,"url":"https://github.com/timdp/swirly","last_synced_at":"2025-08-20T15:10:21.420Z","repository":{"id":37765576,"uuid":"207356709","full_name":"timdp/swirly","owner":"timdp","description":"A marble diagram generator.","archived":false,"fork":false,"pushed_at":"2023-02-21T15:25:38.000Z","size":5669,"stargazers_count":120,"open_issues_count":8,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-11T21:11:51.338Z","etag":null,"topics":["documentation","javascript","marble-diagrams","nodejs","observable","reactive-programming","rxjs","svg","typescript"],"latest_commit_sha":null,"homepage":"https://swirly.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/timdp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"timdp"}},"created_at":"2019-09-09T16:40:44.000Z","updated_at":"2025-06-06T09:28:00.000Z","dependencies_parsed_at":"2024-01-15T20:49:55.337Z","dependency_job_id":"5182186f-45eb-429f-8325-18446a186b38","html_url":"https://github.com/timdp/swirly","commit_stats":{"total_commits":377,"total_committers":2,"mean_commits":188.5,"dds":0.01326259946949604,"last_synced_commit":"103f0a00bc4d84c898f991fa2108891a4c0d66eb"},"previous_names":[],"tags_count":73,"template":false,"template_full_name":null,"purl":"pkg:github/timdp/swirly","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timdp%2Fswirly","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timdp%2Fswirly/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timdp%2Fswirly/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timdp%2Fswirly/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timdp","download_url":"https://codeload.github.com/timdp/swirly/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timdp%2Fswirly/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261361480,"owners_count":23147205,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["documentation","javascript","marble-diagrams","nodejs","observable","reactive-programming","rxjs","svg","typescript"],"created_at":"2024-08-04T18:01:18.652Z","updated_at":"2025-06-25T12:36:12.506Z","avatar_url":"https://github.com/timdp.png","language":"TypeScript","funding_links":["https://github.com/sponsors/timdp"],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Swirly\" src=\"https://user-images.githubusercontent.com/201034/82764045-6173da00-9e0c-11ea-9bee-4fb6543d977a.png\" width=\"480\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  A marble diagram generator.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/swirly\"\u003e\u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/v/swirly.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://standardjs.com\"\u003e\u003cimg alt=\"JavaScript Standard Style\" src=\"https://img.shields.io/badge/code%20style-standard-brightgreen.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Example\n\nHere's Swirly rendering the effect of the `concatAll` operator:\n\n![concatAll](examples/concatAll.png)\n\nThe image above was built from\n[this marble diagram specification](examples/concatAll.txt).\n\nDiagram specifications use an extension of the syntax used for\n[RxJS marble testing](https://github.com/ReactiveX/rxjs/blob/fc3d4264395d88887cae1df2de1b931964f3e684/docs_app/content/guide/testing/marble-testing.md).\nPlease consult the [examples](examples.md) to learn how to create diagrams.\n\n## Web Version\n\nYou can use Swirly in your browser at\n[**swirly.dev**](https://swirly.dev/).\n\nThe Web version allows you to edit diagram specifications in real time and\nexport them to an SVG or a PNG image.\n\n## CLI Version\n\nSwirly is also available as a command-line utility. To run it, you need a\nsufficiently recent version of [Node.js](https://nodejs.org/).\n\nTo install Swirly on your machine, just install the `swirly` npm package:\n\n```bash\nnpm install -g swirly\n```\n\nNext, create `diagram.txt` with your diagram specification. Take a look at the\n[examples](examples/) to learn about the expected syntax.\n\nYou can then generate an SVG image from the specification by simply running:\n\n```bash\nswirly diagram.txt diagram.svg\n```\n\nSwirly can also output PNG images. Since PNG is a raster image format, you may\nwant to increase the resolution to get a higher-quality result. You can do so by\npassing `--scale` followed by a percentage. For example, this will render the\nimage at twice its original size:\n\n```bash\nswirly --scale=200 diagram.txt diagram.png\n```\n\n## Author\n\n[Tim De Pauw](https://tmdpw.eu)\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimdp%2Fswirly","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimdp%2Fswirly","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimdp%2Fswirly/lists"}