{"repo":"hedgedoc/cli","free":true,"listed":false,"github":"https://github.com/hedgedoc/cli","clone":"git clone https://github.com/hedgedoc/cli.git","description":"A tiny CLI for HedgeDoc","language":"Shell","stars":166,"topics":["codimd","cli","cli-app","codimd-cli","bash","markdown","notes","archiving","backup-utility","hedgedoc"],"license":"AGPL-3.0","category":"cli-tools","readme_excerpt":"hedgedoc-cli A tiny CLI to perform common operations on HedgeDoc (the largest open-source fork of HackMD). For more background, see the initial discussion on the hackmd codimd repo. There is an alternative, TypeScript-based CodiMD CLI for hackmdio/codimd maintained by the HackMD team here: https://github.com/hackmdio/codimd-cli. (it may or may not be compatible with the hedgedoc/hedgedoc server) Installation Dependencies - A HedgeDoc server running somewhere - curl (install via apt install curl or brew install curl on Mac) - wget (install via apt install wget or brew install wget on Mac) - jq (install via apt install jq or brew install jq on Mac) Instructions Clone the repository. $ git clone https://github.com/hedgedoc/cli Enter the folder with the script. $ cd cli/bin Optionally symlink the hedgedoc script somewhere into your $PATH to make it globally accessible. Otherwise you will have to provide the path to the script manually. This command might need admin rights (sudo)! $ ln -s $PWD/hedgedoc /usr/local/bin/hedgedoc Check if the new command exists. You should see the documentation $ hedgedoc Set HEDGEDOC SERVER environment variable to your server's URL. It defaults to http://127.0.0.1:3000 Do this once on the command line or persist it in .profile and/or .bashrc . $ export HEDGEDOC SERVER='https://hedgedoc.example.com' If you added the variable to .profile or .bashrc , re-open the terminal to read the new variable. Test your configuration by creating a new note with FREE","default_branch":null,"files":null,"tree":[],"storefront":"/r/hedgedoc","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/hedgedoc/cli/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}