foomo-docs/assets/js/92fae144.51b89c79.js

"use strict";(self.webpackChunkfoomo=self.webpackChunkfoomo||[]).push([[3177],{4767:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>c,metadata:()=>s,toc:()=>a});var n=r(5893),o=r(3905);const c={},i="cli",s={id:"projects/gotsrpc/cli/index",title:"cli",description:"Command line program to generate gotsrpc clients and service proxies.",source:"@site/docs/projects/gotsrpc/cli/index.md",sourceDirName:"projects/gotsrpc/cli",slug:"/projects/gotsrpc/cli/",permalink:"/docs/projects/gotsrpc/cli/",draft:!1,unlisted:!1,editUrl:"https://github.com/foomo/foomo-docs/tree/main/foomo/docs/projects/gotsrpc/cli/index.md",tags:[],version:"current",frontMatter:{},sidebar:"projectsSidebar",previous:{title:"Getting started",permalink:"/docs/projects/gotsrpc/getting-started"},next:{title:"gotsrpc.yaml",permalink:"/docs/projects/gotsrpc/cli/gotsrpc.yaml"}},l={},a=[{value:"Installation",id:"installation",level:2},{value:"Usage",id:"usage",level:2}];function p(e){const t={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",pre:"pre",ul:"ul",...(0,o.ah)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"cli",children:"cli"}),"\n",(0,n.jsx)(t.p,{children:"Command line program to generate gotsrpc clients and service proxies."}),"\n",(0,n.jsx)(t.h2,{id:"installation",children:"Installation"}),"\n",(0,n.jsxs)(t.p,{children:["Downloads are available here: ",(0,n.jsx)(t.a,{href:"https://github.com/foomo/gotsrpc/releases",children:"https://github.com/foomo/gotsrpc/releases"})]}),"\n",(0,n.jsx)(t.p,{children:"Homebrew:"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-shell",children:"brew tap foomo/tap\nbrew install foomo/tap/gotsrpc\n"})}),"\n",(0,n.jsx)(t.h2,{id:"usage",children:"Usage"}),"\n",(0,n.jsxs)(t.p,{children:["To run a code generation with ",(0,n.jsx)(t.code,{children:"gosrpc"})," run"]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-shell",children:"gotsrpc gotsrpc.yaml\n"})}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsx)(t.li,{children:"the referenced Go code has to compile"}),"\n",(0,n.jsx)(t.li,{children:"mappings for all used packages must be configured"}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"If things do not work as expected - carefully read the output."}),"\n",(0,n.jsx)(t.admonition,{type:"caution",children:(0,n.jsx)(t.p,{children:"Previously generated code will be overwritten and potentially obsolete files will not be deleted - please add a clean to your build"})})]})}function d(e={}){const{wrapper:t}={...(0,o.ah)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},3905:(e,t,r)=>{r.d(t,{ah:()=>a});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function c(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?c(Object(r),!0).forEach((function(t){o(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):c(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function s(e,t){if(null==e)return{};var r,n,o=function(e,t){if(null==e)return{};var r,n,o={},c=Object.keys(e);for(n=0;n<c.length;n++)r=c[n],t.indexOf(r)>=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(n=0;n<c.length;n++)r=c[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),a=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,c=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),u=a(r),m=o,g=u["".concat(l,".").concat(m)]||u[m]||p[m]||c;return r?n.createElement(g,i(i({ref:t},d),{},{components:r})):n.createElement(g,i({ref:t},d))}));d.displayName="MDXCreateElement"}}]);