Developer Release 1 · Documentation

CLI Reference

Commands, arguments, options, and project settings for the ConcordUI command-line tool.

This reference follows the current CLI 0.2.0 source. Your installed executable’s help is authoritative if its published version differs.

concordui --version
concordui help
concordui apple create --help

Run project commands from the folder containing ConcordUI.info. Run init from the parent folder where you want a new project.

Command overview

Command / option	Meaning
`concordui init <name>`	Create a shared starter project.
`concordui doctor`	Inspect development tools and the current project.
`concordui info`	Display the current project’s metadata and framework selection.
`concordui repo`	Open the public framework repository in your browser.
`concordui apple create`	Generate an Apple Xcode project.
`concordui apple ide`	Open the generated project in Xcode.
`concordui apple clean`	Clean Apple build artifacts.
`concordui android create`	Generate an Android Studio project.
`concordui android ide`	Open the generated project in Android Studio.
`concordui android reset`	Clear Android Swift build state and update package dependencies.
`concordui android clean`	Clean Android and supporting Swift build artifacts.
`concordui clean`	Clean all listed project-local build artifacts.
`concordui windows build / ide / reset`	Reserved commands; Windows development is currently unsupported.

Help and version

Command / option	Meaning
`concordui help`	Show top-level usage and commands.
`concordui --help / -h`	Show help.
`concordui help android create`	Show help for a nested command.
`concordui android create --help`	Show the same command’s arguments and options.
`concordui --version`	Print the CLI executable’s version, rather than your app’s version.

Running concordui apple, concordui android, or concordui windows without a subcommand displays that group’s help.

init — initialize an app

concordui init HelloApp
concordui init HelloApp --display-name "Hello App" --key com.example --copyright "© 2026 Your Name."

Creates a new folder with ConcordUI.info, starter Swift application code, runtime resources, and app-icon sources. The editable starter template is downloaded when creating the app. An existing folder with the same name is rejected.

Command / option	Meaning
`<name>`	Required single folder name. A single word without spaces is recommended.
`--display-name / -d <text>`	User-facing app name; defaults to the project name.
`--key / -k <prefix>`	Lowercase reverse-domain prefix, such as com.example, used to form platform identifiers.
`--copyright / -c <text>`	Single-line copyright text; defaults to a notice for the current year.

Context matters: -d on init takes a display-name value. On platform create commands, -d is a deletion flag.

cd HelloApp

doctor — diagnose setup

concordui doctor

Checks Xcode, selected command-line tools, Swift, XcodeGen, Java, Gradle, Android SDK, NDK 29.0.14206865, adb, and the Android Swift SDK. Inside an app it also checks metadata, shared folders, starter code, and generated platform files and targets.

It reports findings; it does not install or repair tools. It checks both platform environments, so an Apple-only developer can still see missing Android tools. Its source prints an issue count without setting a failing exit status for those findings.

Development Tools setup guide →

info — inspect your app

concordui info

Reads ConcordUI.info and prints name, display name, key, app version and build, copyright, framework repository, and branch. It requires a valid project configuration.

repo — open the framework repository

concordui repo

Opens the public ConcordUI framework repository in your browser. This command always uses the public repository URL, even if your app selects an experimental framework repository.

Apple commands

apple create — generate the Xcode project

concordui apple create
concordui apple create --delete

Reads your metadata and framework selection, prepares native app and icon files, and runs XcodeGen. The generated app supports iOS and macOS, connects Shared/Swift and Shared/Files, and includes unit-test and UI-test targets.

Command / option	Meaning
`--delete / -d`	Delete the existing Apple project folder before generating it again. Shared content is preserved; direct edits inside Apple can be lost.

apple ide — open Xcode

concordui apple ide

Opens Apple/<name>.xcodeproj in Xcode. Generate it first. Choose the destination and build/run in Xcode.

apple clean — remove Apple build state

concordui apple clean --dry-run
concordui apple clean

Runs Xcode’s clean action for the generated app scheme and removes listed Apple build directories. It preserves project source files.

Android commands

android create — generate the Android project

concordui android create
concordui android create -d

Uses the repo and branch from ConcordUI.info to retrieve and run the framework’s Tools/AndroidGenerator. It connects your shared Swift code to the generated Android host. Generation uses Xcode’s Swift toolchain through xcrun.

Command / option	Meaning
`--delete / -d`	Delete the existing Android project folder before regeneration. Shared content is preserved; direct edits inside Android can be lost.

android ide — open Android Studio

concordui android ide

Opens the generated Android folder in Android Studio. Generate it first, allow project sync, then select a device and build/run.

android reset — refresh Swift dependencies

concordui android reset

Requires the generated root Package.swift. Removes the root .build directory, then runs swift package update using your shell’s active Swift compiler. It updates package dependencies but does not regenerate the Android project or launch the app.

android clean — remove build artifacts

concordui android clean --dry-run
concordui android clean

Removes listed Android caches/build outputs and the supporting root Swift package build state. It does not update dependencies.

Clean, reset, and regenerate

Command / option	Meaning
`clean`	Remove listed build artifacts across both platforms.
`apple clean`	Xcode clean plus listed Apple build directories.
`android clean`	Listed Android build directories plus root .build and .swiftpm.
`android reset`	Remove root .build, then update Swift package dependencies.
`apple create -d / android create -d`	Replace a generated native project using shared source and configuration.
`--dry-run`	On clean commands: list intended cleanup without deleting files or running Xcode clean.

concordui clean --dry-run
concordui clean

Clean targets these project-local paths when present:

Command / option	Meaning
`Swift`	.build, .swiftpm
`Apple`	Apple/build, Apple/.build, Apple/DerivedData
`Android`	Android/.gradle, Android/.kotlin, Android/build, Android/app/build, Android/.cxx, Android/app/.cxx, Android/.externalNativeBuild, Android/app/.externalNativeBuild

Keep application code and resources in Shared. Commit any changes made directly to generated native projects before using create -d.

Windows placeholders

concordui windows build
concordui windows ide
concordui windows reset

Each currently prints “Windows development is not currently supported.” These commands do not generate, build, open, or reset a Windows app.

ConcordUI.info

This file configures your application and the framework source used during generation.

Command / option	Meaning
`formatVersion`	Project configuration format identifier; init writes 1.
`name`	Project name, used for generated application types and platform project names.
`displayName`	App name shown to users; defaults to name.
`key`	Reverse-domain identifier prefix; combined with the project name for native app identifiers.
`version`	Your app’s version string; current init defaults to 1.0.0.
`build`	Positive integer build number; current init defaults to 1.
`copyright`	Your app’s single-line copyright notice.
`repo`	Framework Git repository; defaults to the public ConcordUI repository.
`branch`	Framework branch; defaults to main.

repo=https://github.com/Zodiac-Innovations/ConcordUI.git
branch=main

To use an experimental framework, edit repo and branch, then regenerate the platform project with create -d. The selected Android framework must contain its Android generator.

Typical workflow

concordui doctor
concordui init HelloApp --display-name "Hello App" --key com.example
cd HelloApp
concordui info
concordui apple create
concordui apple ide
concordui android create
concordui android ide

Use Your First App for the complete walkthrough. Current Apple and Android commands generate projects; compilation and execution happen in their IDEs. Earlier CLI editions may expose different command names—check your installed help.

CLI implementation source · Published CLI repository