{"id":21003285,"url":"https://github.com/koding/kdhelp","last_synced_at":"2025-07-14T18:12:03.304Z","repository":{"id":57288839,"uuid":"14754479","full_name":"koding/kdhelp","owner":"koding","description":"KDHelp is a help bin for Koding VMs","archived":false,"fork":false,"pushed_at":"2014-02-22T03:48:48.000Z","size":420,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-06-28T14:04:16.727Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://koding.com","language":"CoffeeScript","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/koding.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":"2013-11-27T17:49:23.000Z","updated_at":"2014-10-09T10:08:11.000Z","dependencies_parsed_at":"2022-09-18T18:16:50.259Z","dependency_job_id":null,"html_url":"https://github.com/koding/kdhelp","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/koding/kdhelp","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koding%2Fkdhelp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koding%2Fkdhelp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koding%2Fkdhelp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koding%2Fkdhelp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/koding","download_url":"https://codeload.github.com/koding/kdhelp/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koding%2Fkdhelp/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265327832,"owners_count":23747789,"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":[],"created_at":"2024-11-19T08:24:38.172Z","updated_at":"2025-07-14T18:12:03.244Z","avatar_url":"https://github.com/koding.png","language":"CoffeeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# KDHelp\n\nKDHelp is a simple help utility installed on Koding VMs for the purpose of\nhelping users. It occupies the `help` and `kdhelp` namespaces and exposes\nall of the content found within the `./help` directory as a series of commands.\n\nThe help content provided is specific to Koding VMs.\n\n## Installation\n\n```\nnpm -g install kdhelp\n```\n\nNote that you shouldn't need to install this.. it comes with the Koding VMs.\n\n## How to Contribute\n\nEach file in the `./help` directory is mapped to a \"command\" for the help bin.\nSubcommands can be achieved by creating a directory and providing an index file\nfor the main folder command, and named modules within that directory for\nsubcommands.\n\nInternally, each file is a CoffeeScript module. It exports a string, as the\nexport object, and this is used as the contents for the help command.\n\nLogic can be executed to provide dynamic help before the export, such as finding\nthe current user name to display the user directory or the login details\nfor FTP.\n\n### Userdata\n\nA global object `userdata` is exposed to all Help documents when being\nimported. Below is an example object.\n\n```JSON\n{\n  \"home\"        : \"/home/exampleuser\",\n  \"username\"    : \"exampleuser\",\n  \"hostname\"    : \"vm-0.exampleuser.koding.kd.io\",\n  \"vm\"          : \"vm-0\",\n  \"userDomain\"  : \"exampleuser.kd.io\",\n  \"vmDomain\"    : \"vm-0.exampleuser.kd.io\"\n}\n```\n\nWith the CoffeeScript `\"#{userdata.hostname}\"` you can access the data. An\nexample usage of this is below:\n\n```CoffeeScript\nmodule.exports = \"\"\"\nHello #{userdata.username}!\n\nTo view the contents of your #{userdata.home}/Web directory\nvisit: #{userdata.vmDomain}\n\"\"\"\n```\n\n### Disclaimer\n\nRemember that we are installing this on all user VMs, so the help provided must\nrelate to all users, as well as be presented in a way that *all* users will\nunderstand.\n\nToo much information is bad information, so this project must stay on scope.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoding%2Fkdhelp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkoding%2Fkdhelp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoding%2Fkdhelp/lists"}