{"id":37089742,"url":"https://github.com/pwood/fdbexplorer","last_synced_at":"2026-01-14T10:59:59.819Z","repository":{"id":61936732,"uuid":"553177769","full_name":"pwood/fdbexplorer","owner":"pwood","description":"A TUI tool for exploring the status of FoundationDB clusters.","archived":false,"fork":false,"pushed_at":"2025-06-11T15:26:26.000Z","size":3011,"stargazers_count":25,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-11T17:04:42.777Z","etag":null,"topics":["foundationdb","golang","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/pwood.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}},"created_at":"2022-10-17T20:54:43.000Z","updated_at":"2025-06-11T15:26:27.000Z","dependencies_parsed_at":"2023-11-07T15:30:34.211Z","dependency_job_id":"1fd7d19a-d60f-43e4-8a60-7fed01007b25","html_url":"https://github.com/pwood/fdbexplorer","commit_stats":{"total_commits":91,"total_committers":2,"mean_commits":45.5,"dds":0.1648351648351648,"last_synced_commit":"63a61a1077d9117f8ff2341ccf0a9e38ebed73e2"},"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"purl":"pkg:github/pwood/fdbexplorer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pwood%2Ffdbexplorer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pwood%2Ffdbexplorer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pwood%2Ffdbexplorer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pwood%2Ffdbexplorer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pwood","download_url":"https://codeload.github.com/pwood/fdbexplorer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pwood%2Ffdbexplorer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28417808,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T10:47:48.104Z","status":"ssl_error","status_checked_at":"2026-01-14T10:46:19.031Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":["foundationdb","golang","tui"],"created_at":"2026-01-14T10:59:59.203Z","updated_at":"2026-01-14T10:59:59.813Z","avatar_url":"https://github.com/pwood.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# fdbexplorer\n\n[![license](https://img.shields.io/github/license/pwood/fdbexplorer.svg)](https://github.com/pwood/fdbexplorer/blob/master/LICENSE)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg)](https://github.com/RichardLitt/standard-readme)\n\n\u003e A TUI tool for exploring the status of FoundationDB clusters.\n\n## Table of Contents\n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n- [Maintainers](#maintainers)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Background\n\nThe output of `status details` from fdbcli is incomplete, and the JSON file produced by `status json` is difficult\nto consume at a glance. `fdbexplorer` is a took in the same vane as `k9s` to make viewing an FoundationDB cluster\neasier for operators at a glance.\n\nThis tool is early in its life, suggestions or constructive criticism are welcome.\n\n## Screencast\n\n\u003cimg src=\"https://raw.githubusercontent.com/pwood/fdbexplorer/main/demo.gif\" width=\"800px\" alt=\"Demonstration of fdbexplorer\" title=\"Demonstration of fdbexplorer\" /\u003e\n\n## Install\n\nDownload the latest release for your operating system and architecture from: [https://github.com/pwood/fdbexplorer/releases](https://github.com/pwood/fdbexplorer/releases)\n\nThere are many builds, please choose one that is appropriate.\n* `linux/amd64`\n* `darwin/amd64`\n* `darwin/arm64`\n\nDuring the GitHub Action pipeline different artefacts for 7.1.X and 7.3.X are built, compiled against the retrospective\nversion of the Go bindings and `libfdb_c` library. You should choose the distribution that matches the version of the \nFoundationDB client libraries you have installed system-wide.\n\n### Multi-version client\n\nIf you are attempting to use a [multi-version client](https://apple.github.io/foundationdb/api-general.html#multi-version-client)\nthen you should use the version as above that is supported by your system installed FoundationDB client library. You may\nbe able to override this with `LD_LIBRARY_PATH` if you wish to control which library is referenced.\n\nAs per FoundationDB documentation, you should provide the locations to other versions you wish to support by using \nthe `FDB_NETWORK_OPTION_EXTERNAL_CLIENT_DIRECTORY` environment variable. \n\n`fdbexplorer` currently requires `libfdb_c` to support API version **700** or higher.\n\n### Build from source\n\nAlternatively you may build yourself on a machine that has the `foundationdb-clients` installed by:\n\n`go build`\n\n## Usage\n\n`fdbexplorer` is primarily configured by command line parameters, with no command line parameters by default it will \nattempt to connect to FoundationDB, see below.\n\n```shell\n# ./fdbexplorer --help\nfdbexplorer (devel) (rev-3df6e48-dirty)\n\nUsage of ./fdbexplorer:\n  -cluster-file string\n    \tLocation of FoundationDB cluster file, environment variable FDB_CLUSTER_FILE also obeyed. (default \"/etc/foundationdb/fdb.cluster\")\n  -http-address string\n    \tHost and port number for http server to listen on, using 0.0.0.0 for all interface bind. (default \"127.0.0.1:8080\")\n  -http-enable status json\n    \tIf the http output should be enabled, making the status json output available on /status/json.\n  -input-file string\n    \tLocation of an output of 'status json' to explore, will not connect to FoundationDB.\n  -url string\n    \tURL to fetch status json from periodically.\n```\n\n### Connect to FoundationDB\n\nIf you are using a build that was compiled with the FoundationDB shared library (linux/amd64) `fdbexplorer` will be able\nto connect to your FoundationDB cluster directly.\n\n`fdbexplorer` will use the following search path to find a valid cluster file:\n * `-cluster-file` command line argument\n * `FDB_CLUSTER_FILE` environment variable\n * `/etc/foundationdb/fdb.cluster`\n\n### Read a copy of `status json`\n\nIf your FDB cluster is remote or isolated, you may capture a content of `status json` (e.g. `fdbcli --exec 'status json' \u003e status.json`) \nand have `fdbexplorer` read that.\n\n\u003e `fdbexplorer -input-file status.json`\n\n### Provide/Read from a HTTP endpoint\n\nFor convenience `fdbexplorer` will also act as a **simple unauthenticated** HTTP server sharing out the status json.\n\n\u003e `fdbexplorer -http-enable -http-address 0.0.0.0:8888`\n\nIt can then be read by using the following:\n\n\u003e `fdbexplorer -url http://\u003cinternal ip\u003e:8888/status/json`\n\nYou do not have to use `fdbexplorer` to publish the contents of `status json`, however the endpoint you provided must\nreturn a `200` and a `Content-Type` of `application/json`.\n\n## Developing\n\n### FoundationDB Client Library\n\nTo compile `fdbexplorer` on your local machine you will need to install `libfdb_c` for your operating system and\narchitecture, otherwise it will not compile.\n\nThis will need to be 7.3.x at present, as the Go bindings used for development are 7.3. This is available as either the\nraw library `.so/.dylib` or a `.pkg/.deb/.rpm` from [https://github.com/apple/foundationdb/releases/](https://github.com/apple/foundationdb/releases/).\n\n`input/libfdb/fdb.go` uses a `//go:build` directive to only compile if CGO is enabled, and a known official distribution\nfor FoundationDB. Be aware at present there is no official distribution of `libfdb_c` for the linux `arm64` platform.\n\n## Maintainers\n\n[@pwood](https://github.com/pwood)\n\n## Contributing\n\nFeel free to dive in! [Open an issue](https://github.com/pwood/fdbexplorer/issues/new) or submit PRs.\n\nThis project follows the [Contributor Covenant](https://www.contributor-covenant.org/version/1/4/code-of-conduct/) Code\nof Conduct.\n\n## License\n\nCopyright 2022 Peter Wood \u0026 Contributors\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the\nLicense. You may obtain a copy of the License at\n\n       http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"\nAS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific\nlanguage governing permissions and limitations under the License.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpwood%2Ffdbexplorer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpwood%2Ffdbexplorer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpwood%2Ffdbexplorer/lists"}