<!doctype html><html><head><title>Getting Started — Hilbish</title><metacharset=utf-8><metaname=viewportcontent="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><metaname=theme-colorcontent="#ff89dd"><metacontent="/Hilbish/hilbish-flower.png"property="og:image"><metaproperty="og:site_name"content="Hilbish"><metacontent="Getting Started — Hilbish"property="og:title"><metacontent="TostartHilbish,openaterminal.IfHilbishhasbeeninstalledandisnotthedefaultshell,youcansimplyrunhilbishtostartit.Thiswilllaunchanormalinteractivesession.Toexit,youcaneitherruntheexitcommandorhitCtrl+D.
Setting as Default Login shell There are a few ways to make Hilbish your default shell. A simple way is to make it your user/login shell." property="og:description"><metacontent="TostartHilbish,openaterminal.IfHilbishhasbeeninstalledandisnotthedefaultshell,youcansimplyrunhilbishtostartit.Thiswilllaunchanormalinteractivesession.Toexit,youcaneitherruntheexitcommandorhitCtrl+D.
Setting as Default Login shell There are a few ways to make Hilbish your default shell. A simple way is to make it your user/login shell." name=description><metaname=revisit-aftercontent="2 days"><metaname=keywordscontent="Lua,Hilbish,Linux,Shell"><metaproperty="og:locale"content="en_GB"><linkrel=canonicalhref=https://rosettea.github.io/Hilbish/><metaproperty="og:url"content="https://rosettea.github.io/Hilbish/"><linkhref=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.cssrel=stylesheetintegrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVorcrossorigin=anonymous><scriptsrc=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.jsintegrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2crossorigin=anonymous></script>
<spanclass=navbar-toggler-icon></span></button><divclass="collapse navbar-collapse"id=navbarSupportedContent><ulclass="navbar-nav me-auto mb-2 mb-lg-0"><liclass=nav-item><ahref=/Hilbish/class=nav-link>Home</a></li><liclass=nav-item><ahref=/Hilbish/install/class=nav-link>Install</a></li><liclass=nav-item><ahref=/Hilbish/docs/class=nav-link>Docs</a></li></ul></div></div></nav></header><divclass="container py-3 row"><divclass=containerstyle=width:240px><divclass="p-3 col"><ulclass="nav nav-pills mb-auto"><liclass=nav-item><ahref=/Hilbish/docs/class=nav-link><strong>Introduction</strong></a></li><liclass=nav-item><ahref=/Hilbish/docs/getting-started/class=nav-link><strong>Getting Started</strong></a></li><liclass=nav-item><ahref=/Hilbish/docs/faq/class=nav-link><strong>Frequently Asked Questions</strong></a></li><liclass=nav-item><ahref=/Hilbish/docs/features/class=nav-link><strong>Features</strong></a></li><ulstyle=list-style:none><liclass=nav-item><ahref=/Hilbish/docs/features/runner-mode/class=nav-link>Runner Mode</a></li></ul></ul></div></div><divclass="p-3 col"><div><h1>Getting Started</h1><p>To start Hilbish, open a terminal. If Hilbish has been installed and is not the
default shell, you can simply run <code>hilbish</code> to start it. This will launch
a normal interactive session.
To exit, you can either run the <code>exit</code> command or hit Ctrl+D.</p><h2id=setting-as-default>Setting as Default</h2><h3id=login-shell>Login shell</h3><p>There are a few ways to make Hilbish your default shell. A simple way is
to make it your user/login shell.</p><divclass="alert alert-warning d-flex align-items-center"role=alert><svgclass="bi flex-shrink-0 me-2"width="24"height="24"role="img"aria-label="Warning:"><usexlink:href="#exclamation-triangle-fill"/></svg><div>It is not recommended to set Hilbish as your login shell. That is expected to be a
Some distros (namely Fedora) might have <code>lchsh</code> instead, which is used like <code>lchsh <user></code>.
When prompted, you can put the path for Hilbish.</p><h3id=default-with-terminal>Default with terminal</h3><p>The simpler way is to set the default shell for your terminal. The way of
doing this depends on how your terminal settings are configured.</p><h3id=run-after-login-shell>Run after login shell</h3><p>Some shells (like zsh) have an rc file, like <code>.zlogin</code>, which is ran when the shell session
is a login shell. In that file, you can run Hilbish. Example:</p><pretabindex=0><code>exec hilbish -S -l
</code></pre><p>This will replace the shell with Hilbish, set $SHELL to Hilbish and launch it as a login shell.</p><h2id=configuration>Configuration</h2><p>Once installation and setup has been done, you can then configure Hilbish.
It is configured and scripted via Lua, so the config file is a Lua file.
You can use any pure Lua library to do whatever you want.</p><p>Hilbish’s sample configuration is usually located in <code>hilbish.dataDir .. '/.hilbishrc.lua'</code>.
You can print that path via Lua to see what it is: <code>print(hilbish.dataDir .. '/.hilbishrc.lua')</code>.
As an example, it will usually will result in <code>/usr/share/hilbish/.hilbishrc.lua</code> on Linux.</p><p>To edit your user configuration, you can copy that file to <code>hilbish.userDir.config .. '/hilbish/init.lua'</code>,
which follows XDG on Linux and MacOS, and is located in %APPDATA% on Windows.</p><p>As the directory is usually <code>~/.config</code> on Linux, you can run this command to copy it:<br><code>cp /usr/share/hilbish/.hilbishrc.lua ~/.config/hilbish/init.lua</code></p><p>Now you can get to editing it. Since it’s just a Lua file, having basic
knowledge of Lua would help. All of Lua’s standard libraries and functions
from Lua 5.4 are available. Hilbish has some custom and modules that are
available. To see them, you can run the <code>doc</code> command. This also works as
