{"id":13471451,"url":"https://github.com/blinklabs-io/nview","last_synced_at":"2025-04-30T17:27:01.691Z","repository":{"id":155501960,"uuid":"623674723","full_name":"blinklabs-io/nview","owner":"blinklabs-io","description":"A TUI for monitoring Cardano nodes","archived":false,"fork":false,"pushed_at":"2025-04-27T13:48:26.000Z","size":248866,"stargazers_count":32,"open_issues_count":10,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-27T14:33:51.096Z","etag":null,"topics":["blockchain","cardano","cardano-node","go","golang","terminal-app","tui"],"latest_commit_sha":null,"homepage":"","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/blinklabs-io.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-04-04T21:09:47.000Z","updated_at":"2025-04-27T13:48:29.000Z","dependencies_parsed_at":"2024-04-15T13:36:51.533Z","dependency_job_id":"3f4f234e-d31e-4cf8-8af6-2e4c98f13f88","html_url":"https://github.com/blinklabs-io/nview","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blinklabs-io%2Fnview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blinklabs-io%2Fnview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blinklabs-io%2Fnview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blinklabs-io%2Fnview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blinklabs-io","download_url":"https://codeload.github.com/blinklabs-io/nview/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251750457,"owners_count":21637725,"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":["blockchain","cardano","cardano-node","go","golang","terminal-app","tui"],"created_at":"2024-07-31T16:00:45.146Z","updated_at":"2025-04-30T17:27:01.657Z","avatar_url":"https://github.com/blinklabs-io.png","language":"Go","funding_links":[],"categories":["Go","区块链","Blockchain"],"sub_categories":[],"readme":"# nview\n\nnview is a local monitoring tool for a Cardano Node (cardano-node) meant to\ncomplement remote monitoring tools by providing a local view of a running\nnode from the command line. It's a TUI (terminal user interface) designed to\nfit most screens.\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"./nview-20240208.png\" alt=\"nview screenshot\" width=\"640\"\u003e\n\u003c/div\u003e\n\n## Design and functionality\n\nThe goal with nview is to provide an alternative to the Guild LiveView\n(gLiveView.sh) shell scripts which is shipped as a single binary with all of\nthe functionality included natively. This allows the tool to be more portable\nto non-Linux systems by using Go standard library functionality.\n\nThe design is more in line with a 12-factor application, with no config\nfiles or other on-disk requirements. Functionality is controlled via\nenvironment variables within the application's context. This prevents the\napplication from being a drop-in replacement for gLiveView for Cardano Node\nadministrators, but unlocks the ability to add functionality beyond that\neasily attainable with a shell script.\n\n## Usage\n\nRunning nview against a running Cardano Node will work out of the box with a\ndefault Cardano Node configuration, which exposes metrics in Prometheus data\nformat on a specific port.\n\n```bash\n./nview\n```\n\nOr, from source:\n```bash\ngo run .\n```\n\n### Configuration\n\nConfiguration can be controlled by either a configuration file or environment\nvariables. In cases where both are present, the environment variable takes\nprecedence.\n\n#### Configuration (env)\n\nThe following environment variables control the behavior of the application.\n\n- `NODE_NAME` - Changes the name displayed by nview, default is \"Cardano\n  Node\", maximum 19 characters\n- `NETWORK` - Short-cut environment variable to use a default configuration\n  for the given known named network. Overrides `CARDANO_NETWORK`, default \"\"\n- `CARDANO_NETWORK` - Named network configured on the Cardano Node, default\n  is \"mainnet\"\n- `PROM_HOST` - Sets the host address used to fetch Prometheus metrics from a\n  Cardano Node, default is \"127.0.0.1\"\n- `PROM_PORT` - Sets the host port used to fetch Prometheus metrics from a\n  Cardano Node, default is 12798\n- `PROM_TIMEOUT` - Sets the maximum number of seconds to wait for response\n  when polling a Cardano Node for Prometheus metrics, default is 3\n\n#### Configuration (YAML)\n\nTo use a configuration file, run `nview` with a command line flag to set the\nfile to load as a configuration.\n\n```bash\n./nview -config /path/to/config.yml\n```\n\nconfig.yaml:\n```\napp:\n  nodeName: Cardano Node\n  network:\nnode:\n  network: mainnet\n  port: 3001\nprometheus:\n  host: 127.0.0.1\n  port: 12798\n  timeout: 3\n```\n\nAn example configuration is provided at `config.yaml.example`.\n\n## GeoLocation\n\nWe embed free GeoLite2 city data created by MaxMind, available\nfrom https://www.maxmind.com and licensed under CC BY-SA 4.0\n\u003chttps://creativecommons.org/licenses/by-sa/4.0/\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblinklabs-io%2Fnview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblinklabs-io%2Fnview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblinklabs-io%2Fnview/lists"}