{"id":13661521,"url":"https://github.com/jamestomasino/burrow","last_synced_at":"2026-02-06T17:37:47.541Z","repository":{"id":48079149,"uuid":"118211265","full_name":"jamestomasino/burrow","owner":"jamestomasino","description":"burrow is a helper for building and managing a gopher hole","archived":false,"fork":false,"pushed_at":"2021-10-22T20:14:14.000Z","size":134,"stargazers_count":56,"open_issues_count":5,"forks_count":10,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-11-10T16:45:13.540Z","etag":null,"topics":["bash-completion","gopher","gopher-hole","gopher-server","makefile","manpage","shell-script"],"latest_commit_sha":null,"homepage":"gopher://gopher.black","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jamestomasino.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}},"created_at":"2018-01-20T05:09:26.000Z","updated_at":"2024-09-06T13:32:03.000Z","dependencies_parsed_at":"2022-08-12T18:10:26.814Z","dependency_job_id":null,"html_url":"https://github.com/jamestomasino/burrow","commit_stats":null,"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamestomasino%2Fburrow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamestomasino%2Fburrow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamestomasino%2Fburrow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamestomasino%2Fburrow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jamestomasino","download_url":"https://codeload.github.com/jamestomasino/burrow/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250742115,"owners_count":21479734,"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":["bash-completion","gopher","gopher-hole","gopher-server","makefile","manpage","shell-script"],"created_at":"2024-08-02T05:01:36.346Z","updated_at":"2026-02-06T17:37:47.531Z","avatar_url":"https://github.com/jamestomasino.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# burrow ![status](https://travis-ci.com/jamestomasino/burrow.svg?branch=master) ![license](https://img.shields.io/badge/license-GPL3-blue.svg?style=flat-square)\n\n**burrow** is a helper for building and managing a gopher hole.\n\n## Installation\n\n_Note: On systems without admin access the binary can be run directly from the\ngit repo, but will lack `man` support and command completion._\n\nSee the [Getting Started](https://github.com/jamestomasino/burrow/wiki/Getting-Started) guide.\n\n### Install on Linux / MacOS\n\n`sudo make install`\n\n### Install on BSD systems\n\n#### FreeBSD\n\n- Installing bash-completion via either `pkg install bash-completion` or via the `shells/bash-completion` port.\n- Installing the GNU version of make via either `pkg install gmake` or the `port devel/gmake`.\n- Rather than using `sudo make install`, run `sudo gmake install`.\n\n#### OpenBSD\n\n- Install the GNU version of make via either `pkg_add gmake` or the port `devel/gmake`.\n- There is no bash-completion package or port in OpenBSD. However the source code can be found at https://github.com/scop/bash-completion\n- Burrow appears to install and run without the presence of bash-completion. Exercise caution.\n- As root (or via `doas`), run `gmake install`.\n\n\n### Uninstall\n\n`sudo make uninstall` # or gmake uninstall on BSD\n\n## Usage\n\n```bash\nburrow phlog          # create new phlog post\nburrow gophermap      # edit a gophermap\nburrow rss            # generate a RSS feed of phlog entries\nburrow edit-config    # open your config file for editing\nburrow update-git     # pull latest git repo for gopher dir, if exists\n```\n\n- `edit-config` will open your burrow configuration file for easy editing.\n\n- `phlog` will prompt for the title of a new post, then open it in your default\n`$EDITOR`.\n\n- `gophermap` will open a gophermap file for editing. This will\nremove any `type i` formatting and allow comments to be added in natural text.\nYou will still need to create links in the proper gophermap formatting.\n\n- `rss` will automatically generate an RSS feed of your most recent phlog\nentries and output it to the root of your gopher directory. This can be\nautomatically generated by using the config option `config_phlog_autorss`.\n\n- `update-git` will silently attempt to update a git repository at the location\nof your gopher hole. It is appropriate for use by a cron job.\n\n_`man burrow` or `burrow -h` for more information._\n\n## Config\n\nThe following locations are available for configuration:\n\n1) `/etc/burrow/config`\n2) `$XDG_CONFIG_HOME`\n3) `$HOME/.config/burrow/config`\n4) `$HOME/.config/burrow`\n5) `$HOME/.burrow`\n\nThese files are processed in the order listed. Variables defined in multiple\nlocations will use the last assigned value.\n\nThe following options are available (defaults shown):\n\n```bash\nconfig_dir_gopher=\"$HOME/gopher\"       # local path to gopher site\nconfig_gopher_server=\"sdf.org\"         # server of gopher host\nconfig_gopher_port=\"70\"                # port of gopher host\nconfig_gopher_root=\"/users/username/\"  # path on gopher host to gopher site\n\nconfig_dir_phlog=\"phlog\"               # relative path to phlog\nconfig_phlog_gophermap=true            # phlogs use gophermap format by default\nconfig_phlog_usedate=true              # use a date-stamp on phlog posts\n\nconfig_git_commit=false                # automatically commit changes if git repo\nconfig_git_push=false                  # automatically push changes if git repo\n\nconfig_autoindent=true                 # automatically reformat gophermaps with leading \"i\"\n                                       # types and parse links at the end of file\n\nconfig_file_rss=\"rss.xml\"              # filename of RSS feed\nconfig_gopher_name=\"My Gopher Hole\"    # used in RSS feed output\nconfig_gopher_desc=\"Description\"       # used in RSS feed output\nconfig_rss_num_entries=\"10\"            # number of entries to inclued in RSS feed\nconfig_phlog_autorss=false             # automatically generate RSS feed\n\n```\n\n_Note: This file is a valid Bash script and will be sourced upon load._\n\n## Disambiguity\n\nThere is [another burrow project](https://github.com/sloumdrone/burrow) created\nby _sloumdrone_. His burrow project is a GUI gopher client. Please check it out!\n\nThere is also another project called \"Burrow the Burrows\" which can be found on gopher at: `gopher://kalos.mine.nu/1/burrow/index.gph`. It aims to construct and maintain a graph of the whole Gopherspace.\n\nThere is another [static site generator for gopher](https://github.com/hyperrealgopher/burrow) written in Haskell by @hyperrealgopher. It has similar features to my burrow.\n\n_Armen_ now has a [gemini \u0026 spartan server](https://gitlab.com/armen138/burrow) named burrow.\n\n## Contributing\nPull requests are welcome. For major changes, please open an issue first to\ndiscuss what you would like to change.\n\n## License\n[GPL3](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjamestomasino%2Fburrow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjamestomasino%2Fburrow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjamestomasino%2Fburrow/lists"}