{"id":16963822,"url":"https://github.com/hellt/yangpath","last_synced_at":"2025-03-22T14:30:58.632Z","repository":{"id":57537589,"uuid":"285194226","full_name":"hellt/yangpath","owner":"hellt","description":"YANG Paths exporter","archived":false,"fork":false,"pushed_at":"2020-09-23T07:17:17.000Z","size":558,"stargazers_count":30,"open_issues_count":7,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-18T11:52:02.618Z","etag":null,"topics":["gnmi","goyang","netconf","network","openconfig","restconf","yang"],"latest_commit_sha":null,"homepage":"https://yangpath.netdevops.me","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hellt.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},"funding":{"github":["hellt"],"custom":["https://www.paypal.me/rdodin","https://www.paypal.me/kmrdi"]}},"created_at":"2020-08-05T05:56:14.000Z","updated_at":"2024-07-09T08:09:13.000Z","dependencies_parsed_at":"2022-09-04T14:01:15.959Z","dependency_job_id":null,"html_url":"https://github.com/hellt/yangpath","commit_stats":null,"previous_names":["hellt/yangform"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hellt%2Fyangpath","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hellt%2Fyangpath/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hellt%2Fyangpath/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hellt%2Fyangpath/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hellt","download_url":"https://codeload.github.com/hellt/yangpath/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244971760,"owners_count":20540849,"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":["gnmi","goyang","netconf","network","openconfig","restconf","yang"],"created_at":"2024-10-13T23:26:16.484Z","updated_at":"2025-03-22T14:30:58.243Z","avatar_url":"https://github.com/hellt.png","language":"Go","funding_links":["https://github.com/sponsors/hellt","https://www.paypal.me/rdodin","https://www.paypal.me/kmrdi"],"categories":[],"sub_categories":[],"readme":"\u003cp align=center\u003e\u003cimg src=https://gitlab.com/rdodin/pics/-/wikis/uploads/d75fb0e5c73cbe358bf900e16961cffc/yangpath_logo_paths.svg?sanitize=true/\u003e\u003c/p\u003e\n\n[![github release](https://img.shields.io/github/release/hellt/yangpath.svg?style=flat-square\u0026color=00c9ff\u0026labelColor=bec8d2)](https://github.com/hellt/yangpath/releases/)\n[![Github all releases](https://img.shields.io/github/downloads/hellt/yangpath/total.svg?style=flat-square\u0026color=00c9ff\u0026labelColor=bec8d2)](https://github.com/hellt/yangpath/releases/)\n[![Go Report](https://img.shields.io/badge/go%20report-A%2B-blue?style=flat-square\u0026color=00c9ff\u0026labelColor=bec8d2)](https://goreportcard.com/report/github.com/hellt/yangpath)\n[![Doc](https://img.shields.io/badge/Docs-yangpath.netdevops.me-blue?style=flat-square\u0026color=00c9ff\u0026labelColor=bec8d2)](https://yangpath.netdevops.me)\n[![build](https://img.shields.io/github/workflow/status/hellt/yangpath/Test/master?style=flat-square\u0026labelColor=bec8d2)](https://github.com/hellt/yangpath/releases/)\n\n---\n`yangpath` is an XPATH/RESTCONF-styled schema paths exporter with superpowers.\n\nThe exported paths can be immediately used in your NETCONF/RESTCONF or gNMI applications.\n\nDocumentation available at [https://yangpath.netdevops.me](https://yangpath.netdevops.me)\n\n**XPATH paths**\n```text\n$ yangpath export --yang-dir ~/openconfig/public/ \\\n                    --module ~/openconfig/public/release/models/interfaces/openconfig-interfaces.yang\n[rw]  /interfaces/interface[name=*]/config/description  string\n[rw]  /interfaces/interface[name=*]/config/enabled  boolean\n[rw]  /interfaces/interface[name=*]/config/loopback-mode  boolean\n[rw]  /interfaces/interface[name=*]/config/mtu  uint16\n[rw]  /interfaces/interface[name=*]/config/name  string\n[rw]  /interfaces/interface[name=*]/config/type  identityref-\u003eietf-if:interface-type\n\u003cSNIPPED\u003e\n```\n\n**RESTCONF paths**\n```text\n$ yangpath export --yang-dir ~/openconfig/public/ \\\n                    --module ~/openconfig/public/release/models/interfaces/openconfig-interfaces.yang\n                    --style restconf\n[rw]  /interfaces/interface=name/config/description  string\n[rw]  /interfaces/interface=name/config/enabled  boolean\n[rw]  /interfaces/interface=name/config/loopback-mode  boolean\n[rw]  /interfaces/interface=name/config/mtu  uint16\n[rw]  /interfaces/interface=name/config/name  string\n[rw]  /interfaces/interface=name/config/type  identityref-\u003eietf-if:interface-type\n```\n\n## Features\n* **Preserved list keys**  \n    The exported paths have the [list keys present](https://yangpath.netdevops.me/about-paths#keys-in-paths).  \n    Knowing the key names makes it very easy to create XPATH/RESTCONF filters targeting a particular node.  \n* **Readily available for gNMI**  \n    The exported paths are fully compatible with the gNMI paths, thanks to the keys being present and set to the wildcard `*` value.\n* **RESTCONF-ready**  \n    With a matter of a single flag value switch `yangpath` will export the paths in a [RESTCONF style](https://yangpath.netdevops.me/about-paths#path-styles). Paste them in Postman and you're good to go!\n* **Type information**  \n    A unique `yangpath` feature is its ability to provide [the type of a given path](https://yangpath.netdevops.me/about-paths#types). Types give additional context when you retrieve the data, but they are of utter importance for edit the configuration operations.\n* **Fast**  \n    Path export with `yangpath` is quite fast, working with massive models is no longer a problem!\n* **User friendly**  \n    As always, we strive to publish the tools which spark joy, therefore pre-built images with an effortless [installation](https://yangpath.netdevops.me/install) and a beautiful and extensive documentation comes included.\n\n## Quick Start\n\n#### Install\nUse the following installation script to install the latest version.\n```\nsudo curl -sL https://github.com/hellt/yangpath/raw/master/install.sh | sudo bash\n```\nAlternatively, leverage the system [packages](https://yangpath.netdevops.me/install#package-managers) or [docker images](https://yangpath.netdevops.me/install#docker).\n\n#### Export paths\nTo [export](https://yangpath.netdevops.me/export) the paths from a given module:\n```bash\n# assuming cur working dir is the root of openconfig repo\nyangpath export -m release/models/interfaces/openconfig-interfaces.yang\n```\n\n#### Generate HTML path browser\nTo create HTML with paths out of template, leverage [templating capabilities](https://yangpath.netdevops.me/html-template) of `yangpath`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhellt%2Fyangpath","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhellt%2Fyangpath","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhellt%2Fyangpath/lists"}