{"id":13395246,"url":"https://github.com/sunaku/dasht","last_synced_at":"2025-05-16T10:06:14.086Z","repository":{"id":39619633,"uuid":"49841135","full_name":"sunaku/dasht","owner":"sunaku","description":"💁 Search API docs offline, in terminal or browser","archived":false,"fork":false,"pushed_at":"2024-01-27T16:43:48.000Z","size":467,"stargazers_count":843,"open_issues_count":18,"forks_count":28,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-05-10T04:39:22.822Z","etag":null,"topics":["browser-based","dash-docset","documentation-tool","offline-first","shell-scripts","terminal-based","w3m"],"latest_commit_sha":null,"homepage":"https://sunaku.github.io/dasht/man","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sunaku.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2016-01-17T23:43:29.000Z","updated_at":"2025-05-10T04:38:03.000Z","dependencies_parsed_at":"2024-06-19T22:46:05.952Z","dependency_job_id":"845d0bbf-937e-47a5-8169-a0687af549d9","html_url":"https://github.com/sunaku/dasht","commit_stats":{"total_commits":141,"total_committers":7,"mean_commits":"20.142857142857142","dds":0.04255319148936165,"last_synced_commit":"882c7f2a6d23aee57d6220eec42a6e101fc8a60a"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sunaku%2Fdasht","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sunaku%2Fdasht/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sunaku%2Fdasht/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sunaku%2Fdasht/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sunaku","download_url":"https://codeload.github.com/sunaku/dasht/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254509477,"owners_count":22082891,"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":["browser-based","dash-docset","documentation-tool","offline-first","shell-scripts","terminal-based","w3m"],"created_at":"2024-07-30T17:01:47.607Z","updated_at":"2025-05-16T10:06:14.035Z","avatar_url":"https://github.com/sunaku.png","language":"Shell","funding_links":[],"categories":["Shell","Uncategorized"],"sub_categories":["Uncategorized"],"readme":"* Code: \u003chttps://github.com/sunaku/dasht\u003e\n* Docs: \u003chttps://sunaku.github.io/dasht/man\u003e\n* Bugs: \u003chttps://github.com/sunaku/dasht/issues\u003e\n\n# Search API docs offline, in your terminal or browser\n\ndasht is a collection of shell scripts for searching, browsing, and managing\nAPI documentation (in the form of [200+ offline documentation sets][docsets],\ncourtesy of [Dash for macOS][Dash]) all from the comfort of your own terminal!\n\nThe name \"dasht\" is a portmanteau of [Dash] and the letter \"t\", for terminal.\nEtymologically, \"dasht\" is Persian for _plain_, as in an flat expanse of land,\nwhich aptly characterizes the terminal environment where everything is text.\n\n[Dash]: https://kapeli.com/dash\n[docsets]: https://kapeli.com/dash#docsets\n\n## Features\n\n* You never have to leave your terminal!\n\n* Local search engine for web browsers.\n\n* Keep [Dash] docsets anywhere you like.\n\n### Preview\n\nWatch the \"[dasht in a terminal](https://vimeo.com/159462598)\"\nand \"[dasht in a browser](https://vimeo.com/159462774)\" screencasts.\n\n![In your terminal](https://github.com/sunaku/dasht/raw/gh-pages/terminal.png)\n![In your browser](https://github.com/sunaku/dasht/raw/gh-pages/browser.png)\n\n## Dependencies\n\nRequired:\n\n[POSIX]: http://pubs.opengroup.org/onlinepubs/9699919799/\n\n* [POSIX] environment (Linux, BSD, etc.)\n\n[sqlite3]: https://www.sqlite.org/cli.html\n\n* [sqlite3] to search inside [Dash] docsets\n\nOptional:\n\n[wget]: https://www.gnu.org/software/wget/\n\n* [wget] to download [docsets] from [Dash]\n\n[w3m]: http://w3m.sourceforge.net/\n\n* [w3m] to display dasht(1) search results\n\n[socat]: http://www.dest-unreach.org/socat/\n\n* [socat] for dasht-server(1) search engine\n\n[gawk]: https://www.gnu.org/software/gawk/\n\n* [gawk] for dasht-server(1) search engine\n\nDevelopment:\n\n[binman]: https://sunaku.github.io/binman/\n[md2man]: https://sunaku.github.io/md2man/\n\n* [binman] and [md2man] to build manual pages\n\n        gem install binman md2man\n\n## Installation\n\nUsing a package manager:\n\n[![Packaging status](https://repology.org/badge/vertical-allrepos/dasht.svg)](https://repology.org/project/dasht/versions)\n\nManually, on any system:\n\n[download]: https://github.com/sunaku/dasht/releases\n[clone]: https://github.com/sunaku/dasht.git\n\n1.  [Download] a stable release or [clone] this Git repository.\n\n2.  Add the `bin/` folder to your `PATH` environment variable:\n\n        export PATH=$PATH:location_where_you_cloned_or_downloaded_dasht/bin\n\n3.  Add the `man/` folder to your `MANPATH` environment variable:\n\n        export MANPATH=location_where_you_cloned_or_downloaded_dasht/man:$MANPATH\n\n### Vim integration\n\nUse the [vim-dasht](https://github.com/sunaku/vim-dasht) plugin for (Neo)Vim.\n\n### ZSH integration\n\nSource this file in ZSH to activate TAB completion for dasht:\n\n    source location_where_you_cloned_or_downloaded_dasht/etc/zsh/completions.zsh\n\nOr simply add the completions/ directory to your ZSH $fpath\nif you've already set up ZSH's completion system elsewhere:\n\n    fpath+=location_where_you_cloned_or_downloaded_dasht/etc/zsh/completions/\n\n## Usage\n\nFirst, install some [docsets] using dasht-docsets-install(1):\n\n    dasht-docsets-install bash\n\nNext, perform a direct search from the terminal using dasht(1):\n\n    dasht 'c - x'\n\nThen, repeat the search in a web browser using dasht-server(1):\n\n    dasht-server\n\nYou are now ready to use dasht!  Read the manuals below to learn even more.\n\n### Manuals\n\n* You can browse the manuals online at \u003chttps://sunaku.github.io/dasht/man/\u003e.\n\n* If you set `$MANPATH` or installed from a package manager, run `man dasht`.\n\n* Else, run `man -M location_where_you_cloned_or_downloaded_dasht/man dasht`.\n\n### Configuration\n\nYou may optionally configure the `DASHT_DOCSETS_DIR` environment variable,\nwhich defines the filesystem location where your [Dash] docsets are installed.\nIf undefined, its value is assumed to be `$XDG_DATA_HOME/dasht/docsets/` or,\nif `XDG_DATA_HOME` is also undefined, `$HOME/.local/share/dasht/docsets/`.\n\nYou may optionally configure the `DASHT_CACHE_DIR` environment variable,\nwhich defines the filesystem location where download links are cached.\nIf undefined, its value is assumed to be `$XDG_CACHE_HOME/dasht/`\nor, if `XDG_CACHE_HOME` is also undefined, `$HOME/.cache/dasht/`.\n\n## Development\n\nIf you make changes to the embedded manual pages found in the comment headers\nat the top of script files in the `bin/` directory, then remember to run the\n`binman-rake` command afterward to regenerate UNIX manual pages for packaging.\n\n## License\n\n[Spare A Life]: https://sunaku.github.io/vegan-for-life.html\n\u003e Like my work? 👍 Please [spare a life] today as thanks! 🐄🐖🐑🐔🐣🐟✨🙊✌  \n\u003e Why? For 💕 ethics, the 🌎 environment, and 💪 health; see link above. 🙇\n\n(the ISC license)\n\nCopyright 2016 Suraj N. Kurapati \u003chttps://github.com/sunaku\u003e\n\nPermission to use, copy, modify, and/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\nWITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\nMERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\nANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\nWHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\nACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\nOR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\n\n(the GPL license)\n\nA small portion of the dasht-query-exec(1) script was derived from [Zeal](\nhttps://zealdocs.org ), which is licensed under the GNU General Public\nLicense.  Refer to the `bin/dasht-query-exec` file for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsunaku%2Fdasht","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsunaku%2Fdasht","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsunaku%2Fdasht/lists"}