> For the complete documentation index, see [llms.txt](https://docs.flatredball.com/gum/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flatredball.com/gum/cli/cli/new.md). # new ``` gumcli new [] [--template ] ``` Creates a new Gum project. The path is optional — when omitted, a `GumProject` subdirectory is created in the current directory. ## Options * `` *(optional)* — Path for the new project. If no `.gumx` extension is given, creates `/.gumx` inside a new folder named ``. If omitted, the project is created at `./GumProject/GumProject.gumx`. * `--template` / `-t` — Template to use. Default: `forms`. ## Templates ### `forms` (default) Creates a project pre-populated with the full Forms UI control set: * All Forms behaviors (Button, CheckBox, ComboBox, ListBox, Slider, TextBox, etc.) * All Forms components and element variants * Standard elements and StandardGraphics assets * Demo and keyboard screens * `UISpriteSheet.png` and `ProjectCodeSettings.codsj` ### `empty` Creates a minimal project with only the standard elements: * Subfolders: Screens, Components, Standards, Behaviors * 8 standard elements (Circle, Component, Container, NineSlice, Polygon, Rectangle, Sprite, Text) * `ExampleSpriteFrame.png` (default NineSlice texture) ## Examples ``` gumcli new gumcli new MyProject gumcli new path/to/MyProject.gumx gumcli new MyProject --template forms gumcli new MyProject -t empty ``` Output on success: ``` Created project: /full/path/to/MyProject/MyProject.gumx ``` ## Notes * Exits with code 2 if the project file already exists (including when invoked with no path and a `GumProject/GumProject.gumx` is already present in the current directory). * Exits with code 2 if an unknown template name is given. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.flatredball.com/gum/cli/cli/new.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.