Get started quickly with pre-configured NativePHP starter kits
NativeCLI provides starter kits for NativePHP. These kits are designed to help you get started with your project quickly. Each kit is designed to provide a base for your project, with the necessary files and configurations to get you started.
To use a starter kit, you simply invoke the new command with the --using flag and specify the kit you want to use.For example, to create a new project using the NativeCLI flux starter kit, you would run:
nativecli new myproject --using=nativecli/starter-desktop-flux
We welcome contributions and additions to this list. If you have created a starter kit for NativePHP, please consider submitting it to be included in our documentation.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"NativeCLI","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"favicon":"/favicon.svg","navbar":{"links":[{"href":"https://github.com/NativeCLI/nativecli/discussions","label":"Discussions"}],"primary":{"type":"button","label":"Get Started","href":"https://docs.nativecli.com/getting-started/installation"}},"footer":{"socials":{"github":"https://github.com/NativeCLI/nativecli"}},"integrations":{"fathom":{"siteId":"UOLVXIIC"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"NativePHP","icon":"code","href":"https://nativephp.com"},{"anchor":"GitHub","icon":"github","href":"https://github.com/NativeCLI/nativecli"},{"anchor":"Sponsor","icon":"heart","href":"https://github.com/sponsors/PeteBishwhip"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"eviesoftwarelimited","hasAudioNarration":false,"actualSubdomain":"eviesoftwarelimited","customDomains":["docs.nativecli.com"],"gitSource":{"type":"github","owner":"nativecli","repo":"nativecli-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae941439ba6be02bb9a1127:success","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"Documentation","count":23},{"language":"default","tag":"Changelog","count":17},{"language":"default","tag":"Releases","count":17},{"language":"default","tag":"Commands","count":16},{"language":"default","tag":"Getting Started","count":3},{"language":"default","tag":"Community","count":2},{"language":"default","tag":"Guides","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"guides/starter-kits","slug":"/guides/starter-kits","pageMetadata":{"title":"Starter Kits","description":"Get started quickly with pre-configured NativePHP starter kits","href":"/guides/starter-kits","hidden":false},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Get started quickly with pre-configured NativePHP starter kits\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`NativeCLI provides starter kits for NativePHP. These kits are designed to help you get started with your project quickly. Each kit is designed to provide a base for your project, with the necessary files and configurations to get you started.`}),`\n`,_jsx(Heading,{level:`2`,id:`how-to-use-a-starter-kit`,children:`How to use a Starter Kit`}),`\n`,_jsxs(_components.p,{children:[`To use a starter kit, you simply invoke the new command with the `,_jsx(_components.code,{children:`--using`}),` flag and specify the kit you want to use.`]}),`\n`,_jsxs(_components.p,{children:[`For example, to create a new project using the NativeCLI `,_jsx(_components.code,{children:`flux`}),` starter kit, you would run:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`nativecli`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` new`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` myproject`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --using=nativecli/starter-desktop-flux`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`available-starter-kits`,children:`Available Starter Kits`}),`\n`,_jsx(Heading,{level:`3`,id:`flux-for-nativephp-desktop`,children:`Flux for NativePHP Desktop`}),`\n`,_jsx(_components.p,{children:`A starter kit featuring Flux UI components for NativePHP Desktop applications.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.a,{href:`https://github.com/NativeCLI/starter-desktop-flux`,children:`View on GitHub`})}),`\n`,_jsx(Heading,{level:`2`,id:`contributing`,children:`Contributing`}),`\n`,_jsx(_components.p,{children:`We welcome contributions and additions to this list. If you have created a starter kit for NativePHP, please consider submitting it to be included in our documentation.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Starter Kits","description":"Get started quickly with pre-configured NativePHP starter kits","href":"/guides/starter-kits","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"How to use a Starter Kit","slug":"how-to-use-a-starter-kit","depth":2,"children":[]},{"title":"Available Starter Kits","slug":"available-starter-kits","depth":2,"children":[{"title":"Flux for NativePHP Desktop","slug":"flux-for-nativephp-desktop","depth":3,"children":[]}]},{"title":"Contributing","slug":"contributing","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/eviesoftwarelimited/d8df786c4e850a62/js/kapa-widget.js"],"subdomain":"eviesoftwarelimited","siteName":"NativeCLI","title":"Starter Kits - NativeCLI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"guides/starter-kits.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Get started quickly with pre-configured NativePHP starter kits\">\u003cmeta data-mint-head name=\"application-name\" content=\"NativeCLI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/eviesoftwarelimited/KsH-XuXDxwdhw7CA/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/eviesoftwarelimited/KsH-XuXDxwdhw7CA/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/eviesoftwarelimited/KsH-XuXDxwdhw7CA/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/eviesoftwarelimited/KsH-XuXDxwdhw7CA/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/eviesoftwarelimited/KsH-XuXDxwdhw7CA/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/eviesoftwarelimited/KsH-XuXDxwdhw7CA/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/eviesoftwarelimited/KsH-XuXDxwdhw7CA/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/eviesoftwarelimited/KsH-XuXDxwdhw7CA/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/eviesoftwarelimited/KsH-XuXDxwdhw7CA/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Starter Kits - NativeCLI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get started quickly with pre-configured NativePHP starter kits\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"NativeCLI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.nativecli.com/guides/starter-kits\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://eviesoftwarelimited.mintlify.site/_mintlify/api/og/v2?division=Guides\u0026amp;title=Starter+Kits\u0026amp;description=Get+started+quickly+with+pre-configured+NativePHP+starter+kits\u0026amp;theme=be394bdd824f66fd2549706a\u0026amp;signature=7f9436a87e2430fabfd460162d58e43cf53093583608462d96ff3322fc7dfafb\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Starter Kits - NativeCLI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get started quickly with pre-configured NativePHP starter kits\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://eviesoftwarelimited.mintlify.site/_mintlify/api/og/v2?division=Guides\u0026amp;title=Starter+Kits\u0026amp;description=Get+started+quickly+with+pre-configured+NativePHP+starter+kits\u0026amp;theme=be394bdd824f66fd2549706a\u0026amp;signature=7f9436a87e2430fabfd460162d58e43cf53093583608462d96ff3322fc7dfafb\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/eviesoftwarelimited/KsH-XuXDxwdhw7CA/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"NativeCLI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.nativecli.com/guides/starter-kits\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/guides/starter-kits.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.nativecli.com/#organization\",\"name\":\"NativeCLI\",\"url\":\"https://docs.nativecli.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.nativecli.com#website\",\"name\":\"NativeCLI\",\"url\":\"https://docs.nativecli.com\",\"publisher\":{\"@id\":\"https://docs.nativecli.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.nativecli.com/guides/starter-kits#webpage\",\"url\":\"https://docs.nativecli.com/guides/starter-kits\",\"name\":\"Starter Kits\",\"description\":\"Get started quickly with pre-configured NativePHP starter kits\",\"isPartOf\":{\"@id\":\"https://docs.nativecli.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.nativecli.com/guides/starter-kits#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.nativecli.com/guides/starter-kits#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"NativeCLI\",\"item\":\"https://docs.nativecli.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Starter Kits\",\"item\":\"https://docs.nativecli.com/guides/starter-kits\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.nativecli.com/guides/starter-kits#article\",\"headline\":\"Starter Kits\",\"name\":\"Starter Kits\",\"description\":\"Get started quickly with pre-configured NativePHP starter kits\",\"url\":\"https://docs.nativecli.com/guides/starter-kits\",\"mainEntityOfPage\":{\"@id\":\"https://docs.nativecli.com/guides/starter-kits#webpage\"},\"publisher\":{\"@id\":\"https://docs.nativecli.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.nativecli.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"NativeCLI\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"NativeCLI\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/guides/starter-kits.md","siteName":"NativeCLI","nav":{"global":{"anchors":[{"anchor":"NativePHP","icon":"code","href":"https://nativephp.com"},{"anchor":"GitHub","icon":"github","href":"https://github.com/NativeCLI/nativecli"},{"anchor":"Sponsor","icon":"heart","href":"https://github.com/sponsors/PeteBishwhip"}]},"tabs":[{"tab":"Documentation","groups":[{"group":"Getting Started","pages":[{"title":"NativeCLI: Your new best friend...","href":""},{"title":"Installation","href":"/getting-started/installation"},{"title":"Start a New NativePHP Project","href":"/getting-started/start-new-project"}]},{"group":"Commands","pages":[{"title":"new","href":"/commands/new"},{"title":"build","href":"/commands/build"},{"title":"cache:clear","href":"/commands/cache-clear"},{"title":"check-update","href":"/commands/check-update"},{"title":"inertia:fix","href":"/commands/inertia-fix"},{"title":"ios:install","href":"/commands/ios-install"},{"title":"jump","href":"/commands/jump"},{"title":"mobile:install","href":"/commands/mobile-install"},{"title":"mobile:upgrade","href":"/commands/mobile-upgrade"},{"title":"plugin:add","href":"/commands/plugin-add"},{"title":"plugin:list","href":"/commands/plugin-list"},{"title":"plugin:remove","href":"/commands/plugin-remove"},{"title":"plugin:provider","href":"/commands/plugin-provider"},{"title":"plugin:permissions","href":"/commands/plugin-permissions"},{"title":"self-update","href":"/commands/self-update"},{"title":"update","description":"Update NativePHP to the latest version","href":"/commands/update"}]},{"group":"Guides","pages":[{"title":"Starter Kits","href":"/guides/starter-kits"},{"title":"Configuration","description":"Configure NativeCLI behavior for global and project-specific settings","href":"/guides/configuration"}]},{"group":"Community","pages":[{"title":"Contributing","href":"/community/contributing"},{"title":"Sponsoring","href":"/community/sponsoring"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Starter Kits - NativeCLI","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":[],"chunks":[]}