"use strict";(globalThis.webpackChunksimple_scaffold_docs=globalThis.webpackChunksimple_scaffold_docs||[]).push([[526],{5980(e,s,n){n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>c});const a=JSON.parse('{"id":"usage/index","title":"Usage","description":"Simple Scaffold can be used as a CLI tool or as a Node.js library. Both approaches share the","source":"@site/docs/usage/index.md","sourceDirName":"usage","slug":"/usage/","permalink":"/simple-scaffold/docs/usage/","draft":false,"unlisted":false,"editUrl":"https://github.com/chenasraf/simple-scaffold/blob/master/docs/docs/usage/index.md","tags":[],"version":"current","sidebarPosition":0,"frontMatter":{"title":"Usage","sidebar_position":0},"sidebar":"usage","next":{"title":"Templates","permalink":"/simple-scaffold/docs/usage/templates"}}');var t=n(2615),o=n(416);const i={title:"Usage",sidebar_position:0},r="Usage",l={},c=[];function d(e){const s={a:"a",h1:"h1",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"usage",children:"Usage"})}),"\n",(0,t.jsxs)(s.p,{children:["Simple Scaffold can be used as a ",(0,t.jsx)(s.strong,{children:"CLI tool"})," or as a ",(0,t.jsx)(s.strong,{children:"Node.js library"}),". Both approaches share the\nsame core concepts: templates, configuration files, and Handlebars-based token replacement."]}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"./usage/templates",children:"Templates"})," \u2014 how template files and directories work, built-in helpers, and\ncustom helpers"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"./usage/configuration_files",children:"Configuration Files"})," \u2014 reusable scaffold definitions,\nauto-detection, inputs, and remote Git templates"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"./usage/cli",children:"CLI"})," \u2014 all commands, flags, interactive mode, and hooks"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"./usage/node",children:"Node.js API"})," \u2014 programmatic usage, full config interface, and hooks"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"./usage/examples",children:"Examples"})," \u2014 end-to-end examples for CLI and Node.js"]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.a,{href:"./usage/migration",children:"Migration"})," \u2014 upgrading from v1.x or v0.x to the latest version"]}),"\n"]})]})}function u(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},416(e,s,n){n.d(s,{R:()=>i,x:()=>r});var a=n(9471);const t={},o=a.createContext(t);function i(e){const s=a.useContext(o);return a.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function r(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),a.createElement(o.Provider,{value:s},e.children)}}}]);