KLAUS(1)

πŸ‘‘ KLAUS πŸ’…

okay bestie, welcome to the manual for klaus, section 1 of the User Commands manuals. this is the whole vibe, no gatekeeping 🫢


✨ NAME ✨

klaus β€” the easy-to-set-up Git web viewer. literally that's it, that's the whole job πŸ’–


πŸŽ€ SYNOPSIS πŸŽ€

klaus [OPTION]... [DIR]...

🌸 DESCRIPTION 🌸

Klaus is a simple, easy-to-set-up Git web viewer that Just Worksβ„’. no cap, that trademark is doing heavy lifting and it earned it ✨

not me about to say something slightly devastating: the klaus binary just starts a test instance. the klaus script uses wsgiref internally, which does not scale at all β€” it's single-threaded and non-asynchronous. so like, iconic for local vibes, not for the whole internet, iykyk πŸ’€

it supports syntax highlighting and Git Smart HTTP. yes ma'am, both. πŸ¦‹


πŸ’… OPTIONS πŸ’…

  • -h, --help β€” show this help message and exit. classic, we love a quick exit 😌
  • --host HOST β€” default: 127.0.0.1
  • --port PORT β€” default: 8080
  • --site-name SITE_NAME β€” the site name shown in the header. default: your hostname πŸ‘‘
  • --version β€” print version number ⭐
  • -b, --browser β€” open klaus in a browser on server start. main character energy fr fr 🌈
  • -B BROWSER, --with-browser BROWSER β€” specify which browser to use with --browser 🧚
  • --ctags {none,tags-and-branches,ALL} β€” enable ctags for which revisions? default: none.
⚠️ WARNING: Don't use ALL for public servers! seriously bestie, that's a public-server no-no, put it down πŸ™ˆ

πŸ”₯ Git Smart HTTP πŸ”₯

  • --smarthttp β€” enable Git Smart HTTP serving 🫢
  • --htdigest FILE β€” use credentials from FILE πŸ”

πŸ’€ Development flags πŸ’€

DO NOT USE IN PRODUCTION! like, at all, i'm begging 😭

  • --debug β€” Enable Werkzeug debugger and reloader πŸ›

🌟 AUTHORS 🌟

Copyright Β© 2011-2015 Jonas Haag <jonas@lophus.org> and contributors (see Git logs). absolute legends, we stan πŸ’œ


okay and for the cute sign-off: this lil page is from klaus version 4e82832, dated December 2015, and it lives in the KLAUS(1) section of the manual. slay, go read your git logs, mwah πŸŽ€βœ¨πŸ’–

πŸ“¦ where this page comes from