Get Started with Codex CLI

This guide will walk you through the setup process for getting started with Codex.

Check your environment

Open a command-line prompt, Windows Terminal if you have it installed, or else Command Prompt or Windows Powershell from the Start menu.
Setup uno.check by installing or updating the tool with:
```
dotnet tool update -g uno.check
```
Run the tool from the command prompt with the following command:
```
uno-check
```
You can optionally add the --target desktop --target web (or ios, android, windows) parameters based on your intended development platforms.
Follow the instructions indicated by the tool.

You can find additional information about uno-check here.

Open a Terminal.
Setup uno.check by installing or updating the tool with:
```
dotnet tool update -g uno.check
```
Run the tool from the command prompt with the following command:
```
uno-check
```
If the above command fails, use the following:
```
~/.dotnet/tools/uno-check
```
You can optionally add the --target desktop --target web (or ios, android, windows) parameters based on your intended target platforms.
Follow the instructions indicated by the tool

You can find additional information about uno-check here.

Open a Terminal
If dotnet --version returns command not found:
- Follow the official directions for installing .NET.
  
  Important
  
  If you are using Ubuntu 24.04 or earlier, use the Microsoft feed to install .NET. On later versions, you may install .NET directly from Ubuntu's official feed. In any case, you may refer to the directions from Microsoft on installing .NET on Ubuntu and make sure to select your Ubuntu version.
Then, setup uno.check by installing or updating the tool with:
```
dotnet tool update -g uno.check
```
Run the tool from the command prompt with the following command:
```
uno-check
```
If the above command fails, use the following:
```
~/.dotnet/tools/uno-check
```
You can optionally add the --target desktop --target web (or ios, android, windows) parameters based on your intended development platforms.
Follow the instructions indicated by the tool

You can find additional information about uno-check here.

Setting up Uno Platform MCPs

Install Codex CLI using the official commands, for example:

npm i -g @openai/codex
# or on macOS
brew install --cask codex

codex mcp add "uno" --url "https://mcp.platform.uno/v1"
codex mcp add "uno-app" -- dotnet dnx -y uno.devserver --mcp-app

Start Codex CLI and type the following:
```
/mcp
```
This will show the Uno Platform tools available to the agent.

Important

The uno-app MCP may fail to load unless Codex is opened in a folder containing an Uno Platform app.

Setting up the Uno Platform Skills

Uno Platform ships a catalog of agent skills — covering areas such as MVUX, navigation, Uno Toolkit controls, theming, and UI testing — bundled in the uno-platform-studio plugin. Once installed, Codex automatically selects the relevant skills as it works on your prompts.

From a terminal, install the plugin:

codex plugin marketplace add unoplatform/studio
codex plugin install uno-platform-studio@uno-platform

For the full skill catalog, update instructions, and other installation options, see Skills & Plugins.

Next Steps

Now that you are set up, let's create your first app.

Uno TechBite

Getting Started with Uno Platform & Codex CLI - Video Walkthrough:

Get Started with Codex CLI

Check your environment

Setting up Uno Platform MCPs

Important

Setting up the Uno Platform Skills

Next Steps

Uno TechBite