{"id":13337866,"url":"https://github.com/hisaitami/tldr-planck","last_synced_at":"2025-03-11T07:31:34.122Z","repository":{"id":83993495,"uuid":"238001777","full_name":"hisaitami/tldr-planck","owner":"hisaitami","description":"A planck (ClojureScript) based command-line client for TLDR pages","archived":false,"fork":false,"pushed_at":"2025-01-01T14:15:28.000Z","size":213,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-01T15:24:45.127Z","etag":null,"topics":["clojure","clojurescript","tldr","tldr-pages"],"latest_commit_sha":null,"homepage":null,"language":"Clojure","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/hisaitami.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}},"created_at":"2020-02-03T15:48:51.000Z","updated_at":"2025-01-01T14:15:31.000Z","dependencies_parsed_at":"2023-10-24T00:33:21.068Z","dependency_job_id":"ab20d4ac-57c7-4b2b-912e-7464ad14ed40","html_url":"https://github.com/hisaitami/tldr-planck","commit_stats":null,"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hisaitami%2Ftldr-planck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hisaitami%2Ftldr-planck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hisaitami%2Ftldr-planck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hisaitami%2Ftldr-planck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hisaitami","download_url":"https://codeload.github.com/hisaitami/tldr-planck/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242991258,"owners_count":20218135,"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":["clojure","clojurescript","tldr","tldr-pages"],"created_at":"2024-07-29T19:15:10.261Z","updated_at":"2025-03-11T07:31:34.115Z","avatar_url":"https://github.com/hisaitami.png","language":"Clojure","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tldr-planck\n\nA [TLDR pages](https://tldr.sh/) client written in Planck (Stand-alone ClojureScript REPL)\n\n![tldr screenshot](screenshot.png)\n\n## Getting Started\n\n### Prerequisites\n\n[Planck](https://planck-repl.org/), a stand-alone ClojureScript REPL for macOS and Linux based on JavaScriptCore.\n\nOn macOS:\n\n```\nbrew install planck\n```\n\n### Installation\n\nCopy this command `tldr.cljs` to a directory in your path. (~/bin, /usr/local/bin or somewhere)\n\n```\nchmod 755 tldr.cljs\ncp tldr.cljs /usr/local/bin\ntldr.cljs\n```\n\n## Usage\n\n```\nusage: tldr.cljs [OPTION]... PAGE\n\navailable commands:\n  -h, --help                 print this help and exit\n  -C, --color                force color display\n  -p, --platform PLATFORM    select platform, supported are linux / osx / sunos / windows / common\n  -r, --render PATH          render a local page for testing purposes\n  -u, --update               update local database\n  -v, --version              print version and exit\n  -c, --clear-cache          clear local database\n  -V, --verbose              display verbose output\n  -l, --list                 list all entries in the local database\n      --random               show a random command\n```\n\nExamples:\n\n```\ntldr.cljs tar\ntldr.cljs du --platform=osx\ntldr.cljs --list\ntldr.cljs --random\n```\n\nTo display pages in the specified language (such as `ja`, `pt_BR`, or `fr`):\n\n```\nLANG=ja tldr.cljs less\nLANG=fr tldr.cljs --random -p linux\n```\n\nTo control the cache:\n\n ```\n tldr.cljs --update\n tldr.cljs --clear-cache\n ```\n\n To render a local file (for testing):\n\n ```\n tldr.cljs --render /path/to/file.md\n ```\n\n### Use REPL\n\nStart Planck REPL in a terminal window.\n\n```\nplk\n```\n\nLoad `tldr.cljs` and change ns to `tldr.core`.\n\n```clojure\ncljs.user=\u003e (load-file \"tldr.cljs\")\nnil\ncljs.user=\u003e\n```\n\nCall `display` function as follows:\n\n```clojure\n;; display page from the osx platform at random\ncljs.user=\u003e (display (rand-page \"linux\"))\n\n;; display specified page (requires .md extension for the page name)\ncljs.user=\u003e (display \"linux\" \"tar.md\")\n\n;; to change the display language (this may occur warning message)\ncljs.user=\u003e (binding [lang-priority-list [\"ja\" \"en\"]] (display \"linux\" \"tar.md\"))\n```\n\nNOTE: Don't call -main. Otherwise, REPL will terminate.\n\n## Configuration\n\nIf the local database is older than two weeks, attempting to update it.\nTo prevent automatic updates, set the environment variable `TLDR_AUTO_UPDATE_DISABLED`\n\n```\nTLDR_AUTO_UPDATE_DISABLED=1 tldr.cljs tar\n```\n\n## Referenced projects\n\n* [tldr](https://github.com/tldr-pages/tldr) - Simplified and community-driven man pages\n* [tldr-c-client](https://github.com/tldr-pages/tldr-c-client) - C command-line client for tldr pages\n* [tldr-node-client](https://github.com/tldr-pages/tldr-node-client) - Node.js command-line client for tldr pages\n* [tldr-php](https://github.com/BrainMaestro/tldr-php) - PHP Client for tldr\n\n## License\n\nCopyright (c) 2025 hisaitami\n\nDistributed under the terms of the [MIT License](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhisaitami%2Ftldr-planck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhisaitami%2Ftldr-planck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhisaitami%2Ftldr-planck/lists"}