1"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[998],{1019(e,n,i){i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>s,default:()=>d,frontMatter:()=>t,metadata:()=>a,toc:()=>c});const a=JSON.parse('{"id":"setup/configuration","title":"Configuration","description":"By default, aliae expects a YAML file called .aliae.yaml in the user HOME folder.","source":"@site/docs/setup/configuration.mdx","sourceDirName":"setup","slug":"/setup/configuration","permalink":"/docs/setup/configuration","draft":false,"unlisted":false,"editUrl":"https://github.com/jandedobbeleer/aliae/edit/main/website/docs/setup/configuration.mdx","tags":[],"version":"current","frontMatter":{"id":"configuration","title":"Configuration","sidebar_label":"\ud83d\udcdd Configuration"},"sidebar":"docs","previous":{"title":"\ud83d\udc27 Linux","permalink":"/docs/installation/linux"},"next":{"title":"\ud83d\udc1a Shell","permalink":"/docs/setup/shell"}}');var o=i(4848),l=i(8453);const t={id:"configuration",title:"Configuration",sidebar_label:"\ud83d\udcdd Configuration"},s=void 0,r={},c=[{value:"Example",id:"example",level:2},{value:"Execution order",id:"execution-order",level:2}];function h(e){const n={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",...(0,l.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(n.p,{children:["By default, aliae expects a ",(0,o.jsx)(n.code,{children:"YAML"})," file called ",(0,o.jsx)(n.code,{children:".aliae.yaml"})," in the user ",(0,o.jsx)(n.code,{children:"HOME"})," folder.\nYou can however also specify a custom location using the ",(0,o.jsx)(n.code,{children:"--config"})," flag on initialization, or\nby setting the ",(0,o.jsx)(n.code,{children:"ALIAE_CONFIG"})," environment variable prior to initialization."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-zsh",children:"eval \"$(aliae init zsh --config '/Users/aliae/configs/aliae.yaml')\"\n\n# alternatively\n\nexport ALIAE_CONFIG='/Users/aliae/configs/aliae.yaml'\neval \"$(aliae init zsh)\"\n"})}),"\n",(0,o.jsx)(n.p,{children:"The custom location can be a local file, or a URL pointing to a remote config."}),"\n",(0,o.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'# yaml-language-server: $schema=https://aliae.dev/schema.json\nalias:\n - name: a\n value: aliae\n - name: hello-world\n value: echo "hello world"\n type: function\nenv:\n - name: POSH_THEME\n value: \'{{ if match .OS "darwin"}}{{ .Home }}{{ else }}Y:{{ end }}/.posh.omp.jsonc\'\n - name: EDITOR\n value: code-insiders --wait\npath:\n - value: |\n {{ .Home }}/homebrew/bin\n /usr/local/bin/\n /opt/local/bin/\n if: match .OS "darwin"\n - value: |\n {{ .Home }}/go/bin/\nscript:\n - value: |\n oh-my-posh init nu\n source ~/.oh-my-posh.nu\n if: match .Shell "nu"\n - value: |\n load(io.popen(\'oh-my-posh init cmd\'):read("*a"))()\n if: match .Shell "cmd"\n - value: |\n oh-my-posh init pwsh | Invoke-Expression\n if: match .Shell "pwsh"\n - value: |\n xontrib load autovox\n xontrib load vox\n xontrib load voxapi\n xontrib load bashisms\n execx($(oh-my-posh init xonsh))\n if: match .Shell "xonsh"\n - value: |\n eval `oh-my-posh init tcsh`\n if: match .Shell "tcsh"\n - value: |\n eval "$(oh-my-posh init {{ .Shell }})"\n if: match .Shell "bash" "zsh"\nlink:\n - name: ~/.aliae.yaml\n target: ~/dotfiles/aliae.yaml\n - name: ~/.zshrc\n target: $DOTFILES/config/zsh/zshrc\n'})}),"\n",(0,o.jsx)(n.h2,{id:"execution-order",children:"Execution order"}),"\n",(0,o.jsx)(n.p,{children:"Regardless of the order in which sections appear in your configuration file, aliae\nalways renders them in the following order:"}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"/docs/setup/env",children:"Environment variable"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"/docs/setup/path",children:"PATH entry"})}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.a,{href:"/docs/setup/alias",children:"Alias"})," / ",(0,o.jsx)(n.a,{href:"/docs/setup/alias",children:"Function"})]}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"/docs/setup/link",children:"Symbolic link"})}),"\n",(0,o.jsx)(n.li,{children:(0,o.jsx)(n.a,{href:"/docs/setup/script",children:"Script"})}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Within a section, entries are rendered in the order they appear in the\nconfiguration file."})]})}function d(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},8453(e,n,i){i.d(n,{R:()=>t,x:()=>s});var a=i(6540);const o={},l=a.createContext(o);function t(e){const n=a.useContext(l);return a.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),a.createElement(l.Provider,{value:n},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.