SketchyBar/assets/js/3847b3ea.ed4c3f5e.js

"use strict";(self.webpackChunksketchybar_site=self.webpackChunksketchybar_site||[]).push([[581],{3905:function(e,t,n){n.d(t,{Zo:function(){return c},kt:function(){return d}});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?l(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):l(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function i(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},l=Object.keys(e);for(r=0;r<l.length;r++)n=l[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r<l.length;r++)n=l[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),u=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},c=function(e){var t=u(e.components);return r.createElement(s.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,s=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),m=u(n),d=a,f=m["".concat(s,".").concat(d)]||m[d]||p[d]||l;return n?r.createElement(f,o(o({ref:t},c),{},{components:n})):r.createElement(f,o({ref:t},c))}));function d(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,o=new Array(l);o[0]=m;var i={};for(var s in t)hasOwnProperty.call(t,s)&&(i[s]=t[s]);i.originalType=e,i.mdxType="string"==typeof e?e:a,o[1]=i;for(var u=2;u<l;u++)o[u]=n[u];return r.createElement.apply(null,o)}return r.createElement.apply(null,n)}m.displayName="MDXCreateElement"},1959:function(e,t,n){n.r(t),n.d(t,{assets:function(){return c},contentTitle:function(){return s},default:function(){return d},frontMatter:function(){return i},metadata:function(){return u},toc:function(){return p}});var r=n(7462),a=n(3366),l=(n(7294),n(3905)),o=["components"],i={id:"setup",title:"Setup",sidebar_position:1},s=void 0,u={unversionedId:"setup",id:"setup",title:"Setup",description:"Installation",source:"@site/docs/setup.md",sourceDirName:".",slug:"/setup",permalink:"/SketchyBar/setup",tags:[],version:"current",sidebarPosition:1,frontMatter:{id:"setup",title:"Setup",sidebar_position:1},sidebar:"docs",previous:{title:"Features",permalink:"/SketchyBar/features"},next:{title:"Bar Properties",permalink:"/SketchyBar/config/bar"}},c={},p=[{value:"Installation",id:"installation",level:2},{value:"Brew Install",id:"brew-install",level:3},{value:"Fonts",id:"fonts",level:3},{value:"Plugins",id:"plugins",level:3},{value:"Compile from source",id:"compile-from-source",level:3},{value:"Uninstall",id:"uninstall",level:2}],m={toc:p};function d(e){var t=e.components,n=(0,a.Z)(e,o);return(0,l.kt)("wrapper",(0,r.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("h2",{id:"installation"},"Installation"),(0,l.kt)("h3",{id:"brew-install"},"Brew Install"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"brew tap FelixKratz/formulae\nbrew install sketchybar\n")),(0,l.kt)("p",null,"Do not forget to copy the example configuration files to your home directory\n(the brew installation specific commands are listed in the caveats section after the brew install is finished).\nThe default configuration is intentionally sparse, so if you are looking for something more sophisticated as a starting point, you might want to look at\n",(0,l.kt)("a",{parentName:"p",href:"https://github.com/FelixKratz/SketchyBar/discussions/47"},"this discussion")," or my personal ",(0,l.kt)("a",{parentName:"p",href:"https://github.com/FelixKratz/dotfiles"},"dotfiles"),"."),(0,l.kt)("p",null,"Run the bar automatically at startup:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"brew services start sketchybar\n")),(0,l.kt)("p",null,"or in the command line with verbose output:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"sketchybar\n")),(0,l.kt)("h3",{id:"fonts"},"Fonts"),(0,l.kt)("p",null,"The default sketchybar font is the Hack Nerd Font:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"brew tap homebrew/cask-fonts\nbrew install --cask font-hack-nerd-font\n")),(0,l.kt)("p",null,"if you experience missing icons you might need to install it. Any font\nof your liking can be used in sketchybar."),(0,l.kt)("h3",{id:"plugins"},"Plugins"),(0,l.kt)("p",null,"When you use/create additional plugins, make sure that they are made executable via"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"chmod +x name/of/plugin.sh\n")),(0,l.kt)("p",null,"If you run sketchybar from the command line directly with the command ",(0,l.kt)("inlineCode",{parentName:"p"},"sketchybar")," you will see\nall outputs and error messages from your scripts."),(0,l.kt)("p",null,"The default plugin folder is located in ",(0,l.kt)("inlineCode",{parentName:"p"},"~/.config/sketchybar/plugins"),".\nPlugins need to be referenced with absolute paths because relative paths will not be resolved correctly.\nHave a look at the ",(0,l.kt)("a",{parentName:"p",href:"https://github.com/FelixKratz/SketchyBar/discussions/12"},"discussion")," for plugins and share your own if you want to.\nYou should of course vet the code from all plugins before executing them to make sure they are not harming your computer."),(0,l.kt)("h3",{id:"compile-from-source"},"Compile from source"),(0,l.kt)("p",null,"It is easy to compile the project from source:"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},"Install xCode commandline tools:")),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"xcode-select --install\n")),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},"Clone the repository:")),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"git clone https://github.com/FelixKratz/SketchyBar.git\n")),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},"In the sketchybar folder run:")),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"make\n")),(0,l.kt)("p",null,"This will generate a universal binary with arm64 and x86 instructions. It is\npossible to generate an arm64/x86 only binary via:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"make arm64\n")),(0,l.kt)("p",null,"or"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"make x86\n")),(0,l.kt)("p",null,"Compiling on older macOS (pre Big Sur) versions should always be done via ",(0,l.kt)("inlineCode",{parentName:"p"},"make x86"),"."),(0,l.kt)("h2",{id:"uninstall"},"Uninstall"),(0,l.kt)("p",null,"Uninstall via ",(0,l.kt)("inlineCode",{parentName:"p"},"brew"),":"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-bash"},"brew uninstall sketchybar\nbrew untap FelixKratz/formulae\n")))}d.isMDXComponent=!0}}]);