{"id":29151211,"url":"https://github.com/karpeleslab/klbfw-describe","last_synced_at":"2026-02-21T16:40:40.161Z","repository":{"id":282645209,"uuid":"949238735","full_name":"KarpelesLab/klbfw-describe","owner":"KarpelesLab","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-19T23:29:48.000Z","size":267,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-06T11:32:37.613Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/KarpelesLab.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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-03-16T01:36:23.000Z","updated_at":"2025-07-19T23:29:52.000Z","dependencies_parsed_at":"2025-10-06T11:26:45.005Z","dependency_job_id":null,"html_url":"https://github.com/KarpelesLab/klbfw-describe","commit_stats":null,"previous_names":["karpeleslab/klbfw-describe"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/KarpelesLab/klbfw-describe","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarpelesLab%2Fklbfw-describe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarpelesLab%2Fklbfw-describe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarpelesLab%2Fklbfw-describe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarpelesLab%2Fklbfw-describe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KarpelesLab","download_url":"https://codeload.github.com/KarpelesLab/klbfw-describe/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarpelesLab%2Fklbfw-describe/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29686798,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-21T15:51:39.154Z","status":"ssl_error","status_checked_at":"2026-02-21T15:49:03.425Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":[],"created_at":"2025-07-01T00:08:54.332Z","updated_at":"2026-02-21T16:40:40.145Z","avatar_url":"https://github.com/KarpelesLab.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# klbfw-describe\n\nA command-line tool for exploring and documenting KLB API endpoints.\n\n## Installation\n\nYou can use this tool with npx without installing:\n\n```bash\nnpx @karpeleslab/klbfw-describe User\n```\n\nOr install it globally:\n\n```bash\nnpm install -g @karpeleslab/klbfw-describe\nklbfw-describe User\n```\n\n## Usage\n\n```\nnpx @karpeleslab/klbfw-describe [options] \u003capi-path\u003e\n```\n\n### Options\n\n- `--raw`: Show raw JSON output without formatting\n- `--ts`, `--types`: Generate TypeScript type definitions\n- `--get`: Perform a GET request instead of OPTIONS\n- `--mcp`: Run as a Claude MCP server over stdio\n- `--help`, `-h`: Show help message\n\n### Examples\n\n```bash\n# Show all available API objects\nnpx @karpeleslab/klbfw-describe\n\n# Describe a top-level endpoint\nnpx @karpeleslab/klbfw-describe User\n\n# Describe a nested endpoint\nnpx @karpeleslab/klbfw-describe Misc/Debug\n\n# Describe a procedure\nnpx @karpeleslab/klbfw-describe Misc/Debug:testUpload\n\n# Get raw JSON output\nnpx @karpeleslab/klbfw-describe --raw User\n\n# Generate TypeScript definitions\nnpx @karpeleslab/klbfw-describe --ts User\n\n# Get a specific resource\nnpx @karpeleslab/klbfw-describe --get User/12345\n\n# Run as a Claude MCP\nclaude mcp add klbfw-describe -s user -- npx -y @karpeleslab/klbfw-describe --mcp\n```\n\n## Features\n\n- Colorized, formatted output for easy reading\n- Lists all available API objects when run without parameters\n- Shows allowed HTTP methods with color-coding (GET, POST, etc.)\n- Displays API endpoint type (Procedure, Resource, or Collection)\n- Shows code examples for calling procedures\n- Lists arguments with their types and required status\n- Multiple output modes:\n  - Default: Shows detailed information with complete field listings\n  - `--raw`: Shows the raw JSON response for advanced needs\n  - `--ts`: Generates TypeScript type definitions for API objects\n  - `--get`: Fetches actual resources instead of metadata\n  - `--mcp`: Runs as a Claude MCP server over stdio\n- Displays sample or complete fields for resources\n- Groups sub-endpoints alphabetically for easy reference\n\n## Output\n\nThe tool provides different information based on the endpoint type:\n\n### For Procedures\n- Procedure name and type (static/instance)\n- Usage examples in JavaScript and URL format\n- Required and optional arguments with types\n\n### For Resources\n- Resource name and field count\n- Primary key information\n- Sample fields with types and nullability\n\n### For Collections\n- Available methods with argument information\n- Available sub-endpoints grouped alphabetically\n\n## License\n\nMIT","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarpeleslab%2Fklbfw-describe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkarpeleslab%2Fklbfw-describe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarpeleslab%2Fklbfw-describe/lists"}