https://docs.ignite.com/assets/js/abcc1ce3.081f9b4a.js

1"use strict";(globalThis.webpackChunkmy_website=globalThis.webpackChunkmy_website||[]).push([[1236],{15680(e,n,t){t.d(n,{xA:()=>p,yg:()=>m});var i=t(96540);function l(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);n&&(i=i.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,i)}return t}function a(e){for(var n=1;n<arguments.length;n++){var t=null!=arguments[n]?arguments[n]:{};n%2?r(Object(t),!0).forEach((function(n){l(e,n,t[n])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):r(Object(t)).forEach((function(n){Object.defineProperty(e,n,Object.getOwnPropertyDescriptor(t,n))}))}return e}function o(e,n){if(null==e)return{};var t,i,l=function(e,n){if(null==e)return{};var t,i,l={},r=Object.keys(e);for(i=0;i<r.length;i++)t=r[i],n.indexOf(t)>=0||(l[t]=e[t]);return l}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i<r.length;i++)t=r[i],n.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(l[t]=e[t])}return l}var s=i.createContext({}),u=function(e){var n=i.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):a(a({},n),e)),t},p=function(e){var n=u(e.components);return i.createElement(s.Provider,{value:n},e.children)},g={inlineCode:"code",wrapper:function(e){var n=e.children;return i.createElement(i.Fragment,{},n)}},c=i.forwardRef((function(e,n){var t=e.components,l=e.mdxType,r=e.originalType,s=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),c=u(t),m=l,y=c["".concat(s,".").concat(m)]||c[m]||g[m]||r;return t?i.createElement(y,a(a({ref:n},p),{},{components:t})):i.createElement(y,a({ref:n},p))}));function m(e,n){var t=arguments,l=n&&n.mdxType;if("string"==typeof e||l){var r=t.length,a=new Array(r);a[0]=c;var o={};for(var s in n)hasOwnProperty.call(n,s)&&(o[s]=n[s]);o.originalType=e,o.mdxType="string"==typeof e?e:l,a[1]=o;for(var u=2;u<r;u++)a[u]=t[u];return i.createElement.apply(null,a)}return i.createElement.apply(null,t)}c.displayName="MDXCreateElement"},85040(e,n,t){t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>a,default:()=>g,frontMatter:()=>r,metadata:()=>o,toc:()=>u});var i=t(58168),l=(t(96540),t(15680));const r={sidebar_position:1,description:"Steps to install IGNITE\xae CLI on your local computer."},a="Install IGNITE\xae CLI",o={unversionedId:"welcome/install",id:"version-v30/welcome/install",title:"Install IGNITE\xae CLI",description:"Steps to install IGNITE\xae CLI on your local computer.",source:"@site/versioned_docs/version-v30/01-welcome/02-install.md",sourceDirName:"01-welcome",slug:"/welcome/install",permalink:"/welcome/install",draft:!1,tags:[],version:"v30",sidebarPosition:1,frontMatter:{sidebar_position:1,description:"Steps to install IGNITE\xae CLI on your local computer."},sidebar:"tutorialSidebar",previous:{title:"Introduction to IGNITE\xae CLI: Your Gateway to Blockchain Innovation",permalink:"/welcome"},next:{title:"Introduction",permalink:"/guide/introduction"}},s={},u=[{value:"Prerequisites",id:"prerequisites",level:2},{value:"Operating systems",id:"operating-systems",level:3},{value:"Go",id:"go",level:3}

1,{value:"Verify your IGNITE\xae CLI version",id:"verify-your-ignite-cli-version",level:2},{value:"Installing IGNITE\xae CLI",id:"installing-ignite-cli",level:2},{value:"Install manually",id:"install-manually",level:3},{value:"Upgrading your IGNITE\xae CLI installation",id:"upgrade",level:2},{value:"Build from source",id:"build-from-source",level:2},{value:"Summary",id:"summary",level:2}],p={toc:u};function g(e){let{components:n,...t}=e;return(0,l.yg)("wrapper",(0,i.A)({},p,t,{components:n,mdxType:"MDXLayout"}),(0,l.yg)("h1",{id:"install-ignite-cli"},"Install IGNITE\xae CLI"),(0,l.yg)("p",null,"You can run ",(0,l.yg)("a",{parentName:"p",href:"https://github.com/ignite/cli"},"IGNITE\xae CLI")," in a web-based IDE or you can install IGNITE\xae CLI on your local computer."),(0,l.yg)("h2",{id:"prerequisites"},"Prerequisites"),(0,l.yg)("p",null,"Be sure you have met the prerequisites before you install and use IGNITE\xae CLI."),(0,l.yg)("h3",{id:"operating-systems"},"Operating systems"),(0,l.yg)("p",null,"IGNITE\xae CLI is supported for the following operating systems:"),(0,l.yg)("ul",null,(0,l.yg)("li",{parentName:"ul"},"GNU/Linux"),(0,l.yg)("li",{parentName:"ul"},"macOS"),(0,l.yg)("li",{parentName:"ul"},"Windows Subsystem for Linux (WSL)")),(0,l.yg)("h3",{id:"go"},"Go"),(0,l.yg)("p",null,"IGNITE\xae CLI is written in the Go programming language. To use IGNITE\xae CLI on a local system:"),(0,l.yg)("ul",null,(0,l.yg)("li",{parentName:"ul"},"Install ",(0,l.yg)("a",{parentName:"li",href:"https://golang.org/doc/install"},"Go")," (",(0,l.yg)("strong",{parentName:"li"},"version 1.26.7")," or higher)"),(0,l.yg)("li",{parentName:"ul"},"Ensure the Go environment variables are ",(0,l.yg)("a",{parentName:"li",href:"https://golang.org/doc/gopath_code#GOPATH"},"set properly")," on your system")),(0,l.yg)("h2",{id:"verify-your-ignite-cli-version"},"Verify your IGNITE\xae CLI version"),(0,l.yg)("p",null,"To verify the version of IGNITE\xae CLI you have installed, run the following command:"),(0,l.yg)("pre",null,(0,l.yg)("code",{parentName:"pre",className:"language-bash"},"ignite version\n")),(0,l.yg)("h2",{id:"installing-ignite-cli"},"Installing IGNITE\xae CLI"),(0,l.yg)("p",null,"To install the latest version of IGNITE\xae use ",(0,l.yg)("a",{parentName:"p",href:"https://formulae.brew.sh/formula/ignite"},"HomeBrew")," on macOS and GNU/Linux:"),(0,l.yg)("pre",null,(0,l.yg)("code",{parentName:"pre",className:"language-sh"},"brew install ignite\n")),(0,l.yg)("h3",{id:"install-manually"},"Install manually"),(0,l.yg)("p",null,"Alternatively, you can install the latest version of the ",(0,l.yg)("inlineCode",{parentName:"p"},"ignite")," binary use the following command:"),(0,l.yg)("pre",null,(0,l.yg)("code",{parentName:"pre",className:"language-bash"},"curl https://get.ignite.com/cli! | bash\n")),(0,l.yg)("p",null,"This command invokes ",(0,l.yg)("inlineCode",{parentName:"p"},"curl")," to download the installation script and pipes the output to ",(0,l.yg)("inlineCode",{parentName:"p"},"bash")," to perform the\ninstallation. The ",(0,l.yg)("inlineCode",{parentName:"p"},"ignite")," binary is installed in ",(0,l.yg)("inlineCode",{parentName:"p"},"/usr/local/bin"),"."),(0,l.yg)("p",null,"IGNITE\xae CLI installation requires write permission to the ",(0,l.yg)("inlineCode",{parentName:"p"},"/usr/local/bin/")," directory. If the installation fails because\nyou do not have write permission to ",(0,l.yg)("inlineCode",{parentName:"p"},"/usr/local/bin/"),", run the following command:"),(0,l.yg)("pre",null,(0,l.yg)("code",{parentName:"pre",className:"language-bash"},"curl https://get.ignite.com/cli | bash\n")),(0,l.yg)("p",null,"Then run this command to move the ",(0,l.yg)("inlineCode",{parentName:"p"},"ignite")," executable to ",(0,l.yg)("inlineCode",{parentName:"p"},"/usr/local/bin/"),":"),(0,l.yg)("pre",null,(0,l.yg)("code",{parentName:"pre",className:"language-bash"},"sudo mv ignite /usr/local/bin/\n")),(0,l.yg)("p",null,"On some machines, a permissions error occurs:"),(0,l.yg)("pre",null,(0,l.yg)("code",{parentName:"pre",className:"language-bash"},"mv: rename ./ignite to /usr/local/bin/ignite: Permission denied\n============\nError: mv failed\n")),(0,l.yg)("p",null,"In this case, use sudo before ",(0,l.yg)("inlineCode",{parentName:"p"},"curl")," and before ",(0,l.yg)("inlineCode",{parentName:"p"}

1,"bash"),":"),(0,l.yg)("pre",null,(0,l.yg)("code",{parentName:"pre",className:"language-bash"},"sudo curl https://get.ignite.com/cli | sudo bash\n")),(0,l.yg)("p",null,"To learn more or customize the installation process, see the ",(0,l.yg)("a",{parentName:"p",href:"https://github.com/ignite/installer"},"installer docs")," on\nGitHub."),(0,l.yg)("h2",{id:"upgrade"},"Upgrading your IGNITE\xae CLI installation"),(0,l.yg)("p",null,"Before you install a new version of IGNITE\xae CLI, remove all existing IGNITE\xae CLI installations."),(0,l.yg)("p",null,"To remove the current IGNITE\xae CLI installation:"),(0,l.yg)("ol",null,(0,l.yg)("li",{parentName:"ol"},"On your terminal window, press ",(0,l.yg)("inlineCode",{parentName:"li"},"Ctrl+C")," to stop the chain that you started with ",(0,l.yg)("inlineCode",{parentName:"li"},"ignite chain serve"),"."),(0,l.yg)("li",{parentName:"ol"},"Remove the IGNITE\xae CLI binary with ",(0,l.yg)("inlineCode",{parentName:"li"},"rm $(which ignite)"),".\nDepending on your user permissions, run the command with or without ",(0,l.yg)("inlineCode",{parentName:"li"},"sudo"),"."),(0,l.yg)("li",{parentName:"ol"},"Repeat this step until all ",(0,l.yg)("inlineCode",{parentName:"li"},"ignite")," installations are removed from your system.")),(0,l.yg)("p",null,"After all existing IGNITE\xae CLI installations are removed, follow the ",(0,l.yg)("a",{parentName:"p",href:"#installing-ignite-cli"},"Installing IGNITE\xae CLI"),"\ninstructions."),(0,l.yg)("p",null,"For details on version features and changes, see\nthe ",(0,l.yg)("a",{parentName:"p",href:"https://github.com/ignite/cli/blob/main/changelog.md"},"changelog.md"),"\nin the repo."),(0,l.yg)("h2",{id:"build-from-source"},"Build from source"),(0,l.yg)("p",null,"To experiment with the source code, you can build from source:"),(0,l.yg)("pre",null,(0,l.yg)("code",{parentName:"pre",className:"language-bash"},"git clone https://github.com/ignite/cli --depth=1\ncd cli && make install\n")),(0,l.yg)("h2",{id:"summary"},"Summary"),(0,l.yg)("ul",null,(0,l.yg)("li",{parentName:"ul"},"Verify the prerequisites."),(0,l.yg)("li",{parentName:"ul"},"To set up a local development environment, install IGNITE\xae CLI locally on your computer."),(0,l.yg)("li",{parentName:"ul"},"Install IGNITE\xae CLI by fetching the binary using cURL or by building from source."),(0,l.yg)("li",{parentName:"ul"},"The latest version is installed by default. You can install previous versions of the precompiled ",(0,l.yg)("inlineCode",{parentName:"li"},"ignite")," binary."),(0,l.yg)("li",{parentName:"ul"},"Stop the chain and remove existing versions before installing a new version.")))}g.isMDXComponent=!0}}]);