1"use strict";(self.webpackChunkfluvio_docs=self.webpackChunkfluvio_docs||[]).push([[210],{25717:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>f,frontMatter:()=>a,metadata:()=>i,toc:()=>c});var t=s(74848),r=s(28453);const a={description:"SDF Generate Command",sidebar_position:30},d="sdf generate",i={id:"cli/generate",title:"sdf generate",description:"SDF Generate Command",source:"@site/sdf_versioned_docs/version-sdf-beta4/cli/generate.mdx",sourceDirName:"cli",slug:"/cli/generate",permalink:"/sdf/sdf-beta4/cli/generate",draft:!1,unlisted:!1,tags:[],version:"sdf-beta4",sidebarPosition:30,frontMatter:{description:"SDF Generate Command",sidebar_position:30},sidebar:"sdf",previous:{title:"sdf setup",permalink:"/sdf/sdf-beta4/cli/setup"},next:{title:"sdf build",permalink:"/sdf/sdf-beta4/cli/build"}},o={},c=[{value:"<code>sdf generate</code> command",id:"sdf-generate-command",level:3},{value:"Examples",id:"examples",level:4},{value:"sdf generate",id:"sdf-generate-1",level:5}];function l(e){const n={a:"a",code:"code",h1:"h1",h3:"h3",h4:"h4",h5:"h5",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"sdf-generate",children:(0,t.jsx)(n.code,{children:"sdf generate"})})}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"sdf generate"})," uses a ",(0,t.jsx)(n.code,{children:"sdf-package.yaml"})," file to generate a project for your custom implementation.\nCheckout ",(0,t.jsx)(n.a,{href:"/sdf/latest/composition/sdf-package-yaml",children:"sdf-package.yaml"})," for additional information."]}),"\n",(0,t.jsxs)(n.h3,{id:"sdf-generate-command",children:[(0,t.jsx)(n.code,{children:"sdf generate"})," command"]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"generate"})," command has the following hierarchy:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",metastring:'copy="fl"',children:"$ sdf generate -h\nGenerate package (requires: sdf-package.yaml)\n\nUsage: sdf generate [OPTIONS]\n\nOptions:\n --dev set runtime to use dev mode [env: DEV=]\n"})}),"\n",(0,t.jsx)(n.p,{children:"Where:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"--dev"})," development profile to be used for generating code"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"examples",children:"Examples"}),"\n",(0,t.jsx)(n.h5,{id:"sdf-generate-1",children:"sdf generate"}),"\n",(0,t.jsxs)(n.p,{children:["Navigate to the directory with ",(0,t.jsx)(n.code,{children:"sdf-package.yaml"})," file, and run the command:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",metastring:'copy="fl"',children:"$ sdf generate\nSuccessfully generated project\n"})}),"\n",(0,t.jsxs)(n.p,{children:["The commands creates directories for all objects in your package file. Checkout the ",(0,t.jsx)(n.a,{href:"/sdf/latest/composition/overview",children:"composition section"})," for additional information."]})]})}function f(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},28453:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>i});var t=s(96540);const r={},a=t.createContext(r);function d(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),t.createElement(a.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.