{"id":20851653,"url":"https://github.com/emsk/skyebridge","last_synced_at":"2025-05-12T04:32:13.752Z","repository":{"id":34924258,"uuid":"188271783","full_name":"emsk/skyebridge","owner":"emsk","description":"Flow diagram generator","archived":false,"fork":false,"pushed_at":"2023-01-07T04:11:18.000Z","size":2131,"stargazers_count":10,"open_issues_count":7,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-19T09:08:53.503Z","etag":null,"topics":["cli","diagram","flow","generator","javascript","nodejs","transition"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/emsk.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-05-23T16:39:34.000Z","updated_at":"2023-09-01T23:25:47.000Z","dependencies_parsed_at":"2023-01-15T10:32:41.624Z","dependency_job_id":null,"html_url":"https://github.com/emsk/skyebridge","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emsk%2Fskyebridge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emsk%2Fskyebridge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emsk%2Fskyebridge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emsk%2Fskyebridge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emsk","download_url":"https://codeload.github.com/emsk/skyebridge/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253675615,"owners_count":21945945,"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":["cli","diagram","flow","generator","javascript","nodejs","transition"],"created_at":"2024-11-18T03:14:27.681Z","updated_at":"2025-05-12T04:32:13.257Z","avatar_url":"https://github.com/emsk.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# skyebridge\n\n[![npm](https://img.shields.io/npm/v/skyebridge.svg)](https://www.npmjs.com/package/skyebridge)\n[![Build Status](https://github.com/emsk/skyebridge/actions/workflows/build.yml/badge.svg)](https://github.com/emsk/skyebridge/actions/workflows/build.yml)\n[![Build Status](https://travis-ci.org/emsk/skyebridge.svg?branch=main)](https://travis-ci.org/emsk/skyebridge)\n[![Build status](https://ci.appveyor.com/api/projects/status/t4f8lvatqdb3l4kj?svg=true)](https://ci.appveyor.com/project/emsk/skyebridge)\n[![codecov](https://codecov.io/gh/emsk/skyebridge/branch/main/graph/badge.svg)](https://codecov.io/gh/emsk/skyebridge)\n[![NPM](https://img.shields.io/npm/l/skyebridge.svg)](LICENSE)\n\nskyebridge is a command-line tool for generating a flow diagram from a JSON file.\n\n![Skye Bridge](skyebridge.jpg?raw=true)\n\n## Installation\n\n```sh\n$ npm install --global skyebridge\n```\n\n## Usage\n\n```sh\n$ skyebridge --input flow.json --output diagram.html\n```\n\n## Command Options\n\n| Option | Alias | Description | Type | Default | Required |\n| :----- | :---- | :---------- | :--- | :------ | :------- |\n| `--input` | `-i` | Input file path or URL (JSON in which a flow is defined) | `String` | | Yes |\n| `--output` | `-o` | Output file path (HTML in which a diagram is drawn) | `String` | | Yes |\n| `--title` | `-t` | Content of `\u003ctitle\u003e\u003c/title\u003e` in the HTML | `String` | `Flow Diagram` | No |\n| `--minify` | `-m` | Minify the HTML | `Boolean` | `false` | No |\n| `--cdn` | `-c` | Minify JavaScript in the HTML by using CDN (works only online) | `Boolean` | `false` | No |\n\n## Try It Out\n\n```sh\n$ npx skyebridge --input https://raw.githubusercontent.com/emsk/skyebridge/main/test/fixtures/input/flow.json --output diagram.html\n```\n\n## Example\n\nInput file:\n\n```json\n{\n  \"nodes\": [\n    {\"id\": 1, \"label\": \"Page 1\"},\n    {\"id\": 2, \"label\": \"Page 2\"},\n    {\"id\": 3, \"label\": \"Page 3\", \"level\": 0},\n    {\"id\": 4, \"label\": \"Page 4\", \"level\": 1},\n    {\"id\": 5, \"label\": \"Page 5\", \"level\": 2},\n    {\"id\": 6, \"label\": \"Page 6\", \"level\": 3},\n    {\"id\": 7, \"label\": \"Page 7\", \"level\": 4}\n  ],\n  \"edges\": [\n    {\"from\": 1, \"to\": 1, \"label\": \"search\"},\n    {\"from\": 1, \"to\": 2, \"label\": \"select\"},\n    {\"from\": 1, \"to\": 3},\n    {\"from\": 2, \"to\": 4, \"label\": \"open\"},\n    {\"from\": 2, \"to\": 5},\n    {\"from\": 4, \"to\": 2, \"label\": \"close\"},\n    {\"from\": 5, \"to\": 6},\n    {\"from\": 6, \"to\": 7}\n  ]\n}\n```\n\nOutput file:\n\n![Diagram](diagram.png?raw=true)\n\nThe nodes are freely draggable.\n\nTry [this example](test/fixtures/output/diagram.html).\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femsk%2Fskyebridge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femsk%2Fskyebridge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femsk%2Fskyebridge/lists"}