{"id":21514725,"url":"https://github.com/SherpaCLI/sherpa","last_synced_at":"2025-07-16T05:32:33.029Z","repository":{"id":65743866,"uuid":"592782818","full_name":"AndiKod/sherpa","owner":"AndiKod","description":"A tool for notes taking and daily activity. Simple, flexible and straight forward from the terminal.","archived":false,"fork":false,"pushed_at":"2023-02-13T20:33:14.000Z","size":50,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2023-02-26T19:23:06.540Z","etag":null,"topics":["bash","bash-script","shell"],"latest_commit_sha":null,"homepage":"","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/AndiKod.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}},"created_at":"2023-01-24T14:26:23.000Z","updated_at":"2023-02-16T00:09:33.000Z","dependencies_parsed_at":"2023-02-19T20:16:08.337Z","dependency_job_id":null,"html_url":"https://github.com/AndiKod/sherpa","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndiKod%2Fsherpa","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndiKod%2Fsherpa/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndiKod%2Fsherpa/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndiKod%2Fsherpa/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AndiKod","download_url":"https://codeload.github.com/AndiKod/sherpa/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226109873,"owners_count":17574943,"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","bash-script","shell"],"created_at":"2024-11-23T23:52:45.561Z","updated_at":"2025-07-16T05:32:25.875Z","avatar_url":"https://github.com/AndiKod.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\" width=\"100%\"\u003e\n    \u003cimg width=\"25%\" src=\"./sherpa.png\"\u003e\n\u003c/p\u003e\n\n# sh:erpa\n\n### Personal Assistant from the shell\n\nA tool for notes taking and daily activity, as I tried Notion and Obsidian but needed something simple, flexible and straight forward from the terminal ...so experimenting.\n\nGreat with [Calepin](https://github.com/AndiKod/calepin). Write plain Markdown and view it in your browser as html with zero config. 100% Vanilla, no NPM, no bloat. Yet, can also work with Astro, 11ty, Vue/Svelte/React/WhateverJS.\n\nIt's a personnal project and still in early days, but feel free to give it a try. It's always good to have a sh:erpa helping you to reach your higher goals faster and safer.  \n\n---\n\n## Install\n\nClone the program in the home folder: \n\n```bash\ncd ~\ngit clone git@github.com:AndiKod/sherpa.git\n```\nAdd that folder to the path by adding that line to *~/.bashrc* : \n\n```bash\nexport PATH=$PATH:$HOME/sherpa/bin\n```\nRestart your terminal and press `s`. Welcome. Hit `s --help` for English or French infos or commands list.\n\nEdit defaults like your prefered text editor in ~/sherpa/bin/s  \n`s config` will open that file with Vim\n`s config-nano` the same but with Nano  \n\nOn the first run of `s`, sh:erpa creates the dot-files and store the default route as `~/.config/sherpa/routes/k1` pointing on $HOME/Documents as a placeholder.\n\nType `s route k1` to edit the content and plug sh:erpa into your project.\n\n\n```bash\n# ~/.config/sherpa/routes/k1  \n\ndefRoot=\"/home/user/Documents\"         # Where .git is\ndefDirectory=\"/home/user/Documents\"    # Globally the /src folder\ndefContent=\"/home/user/Documents\"      # The .md content folder \n```\n\n\n\u003e Find all available 's commands' and some usefull HOWTO pages, in the [Docs](https://github.com/AndiKod/sherpa/tree/master/docs) Both english, or ...en fraçais svp.\n\n### Defaults\n\n\nSherpa uses [Ranger](https://github.com/ranger/ranger) as default file explorer; be sure to have it installed. Vim is the default editor. It's a powerful combo, but you can configure it diferently if needed.\n\nAs main browser, I have Waterfox with Vim keybinds from [Vimium-FF](https://addons.mozilla.org/en-US/firefox/addon/vimium-ff). It synergize well together, as you can forget your mouse and experience a natural flow and privacy, without moving your hands away from the keyboard.\n\n---\n\n### OS specific Programs paths \n\nsh:erpa check if he is called from Windows WSL and identify anyting else as Linux but it could be MacOS.\n\n- To find a program in Linux, type `which program` and you'll get something like `/usr/bin/program`. You can use that in the config.\n\n- For Windows, right click on the program's icon in the launcher \u003e more \u003e show in folder ...then on the shortcut r-click \u003e settings and you'll find the path to the .exe\n\n\n## sh:erpa Modules\n\nEmbracing the Unix phylosophy, sh:erpa use plain text files, does one simple taks at the time ...and is extensible. Below are the first modules to play around with and compose your own experience. Obviously, the FreeSoftware is prefered, but bring in whatever you like.\n\nThe quick list of available commands is in $sherpaDir/docs. Use the `?` s-command to read them in the terminal.  \n\n\n### The s Dashboard\n\nAt any moment, press just `s` and get:\n\n- An ASCII Art tile (maybe alternate ones later)\n- Date, Hour, Greeting in random languages\n- The list of your uncompleted Todos\n- Status of tour Git repo, if you have work to save\n- The author/name of the actual Git remote origin\n- Your actual \"climbing\" Route paths (root, src, content) \n\nSections of this screen could be customised in the future.\nWith simple bash commands, you could create your own widgets or \"s commands\", as I'm looking into ways to simplify the process.\n\n### Quick Edits\n\n- Edit bin/s with Vim or Nano to configure or tweak your sh:erpa \n- Edit .bashrc in the $defEditor\n- Edit vimrc or nvim's init (next) \n\n### Going Places\n\nAliases changing the actual working directory, and \"Go to:\"  \n\n- root: From where we use Git inside our project \n- src: If using sh:erpa with a JamStack framework, you got it\n- content: Where all your actual .md content pages are \n- sherpa: The sherpa folder with the Templates, the Docs, bin/s\n- dotDir: Config folder, data files, registers ...\n\nNew custom aliases could be soon added via the config file.\n\n### List Things\n\n- Short commands to list in tree form the content of:\nroot, content, sherpa, dotDir, templates, docs, data, registers \n\n### Routes\n\n- Create new named route (sets of default paths)\n- Edit the content or Rename/Remove the file  \n- Take the route, set it as your active one \n\n### Todos\n\n- Create\n- Complete\n- reActivate todos \n- Manage todo Lists\n- *[Search, filter, ...with Unix tools]*\n\n### Bookmarks\n\n- Create\n- List\n- Tag \n- Open\n- *[Search, filter, ...with Unix tools]*\n\n\n### Files Operations\n \n- Create files from Templates\n- Write text into a file without opening it (quick notes) \n- Open file with chosen default editor or alternatives\n- Read the content of a file, inside the terminal\n- Open .md files in the Browser as .html with no config (Calepin)\n- Preview file contents within Ranger file explorer\n- *[Search, filter, manage files ...with Unix tools]*\n\n### Handle URLs \u0026 WebSearch\n\n- Open in browser anything starting with \"http...\"\n- Open in Browser anyting ending in .com .org ...\n- Search on DuckDuckGo from the terminal \n\n### Basic Git Operaitions \n\n- Auto status check on the \"s dashboard\"\n- Full git status from anywhere\n- Push all with `toGit \"msg\"` oneliner\n- Pull with `fromGit` oneliner \n\n\n### Folders\n\n- Create folders with $defRoot as starting point\n- Rename folders. Works also with files, like `rename old new`\n- *[Infos and manage ...with Unix tools]*\n\n\n### RSS Reader\n\nBy default it looks for https://newsboat.org \n\n- Open the reader, refresh and happy reading\n- Add a feed from the command line\n- Launch the urls file in Vim \u0026 edit your feeds\n\n### Help Pages\n\n- The traditional --help flag, with English/French menu\n\n### Version \u0026 Infos\n\n- The other  -v or --version traditional flags\n\n\n---\n\n\n\n-Andrei- \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSherpaCLI%2Fsherpa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSherpaCLI%2Fsherpa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSherpaCLI%2Fsherpa/lists"}