ordinary 0.11.1

Ordinary CLI
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

<!--
Copyright (C) 2026 The Ordinary Authors.

SPDX-License-Identifier: BSD-3-Clause
-->

# Ordinary CLI

[![crates.io](https://img.shields.io/crates/v/ordinary.svg)](https://crates.io/crates/ordinary/0.11.1)
[![docs.rs](https://img.shields.io/docsrs/ordinary/0.11.1)](https://docs.rs/ordinary/0.11.1)
[![dependency status](https://deps.rs/crate/ordinary/0.11.1/status.svg)](https://deps.rs/crate/ordinary/0.11.1)
[![License: BSD-3-Clause](https://img.shields.io/badge/license-BSD--3--Clause-blue
)](https://codeberg.org/ordinarylabs/Ordinary/src/branch/main/LICENSE)

Command line interface for Ordinary.

The Ordinary CLI is built with [Clap](https://docs.rs/clap/latest/clap/).

## Installation

Prebuilt releases are provided [here](https://codeberg.org/ordinarylabs/Ordinary/releases).

**Note:** When building from source, [`esbuild`](https://esbuild.github.io/getting-started/#install-esbuild) 
will need to be installed because it is used to bundle the 
[built-in](https://codeberg.org/ordinarylabs/Ordinary/src/branch/main/core/servers/app/assets/v1)
TypeScript/JavaScript files.

### git

```sh
cargo install ordinary --git https://codeberg.org/ordinarylabs/Ordinary.git 
```

### crates.io

```sh
## ordinary CLI
cargo install ordinary@0.11.1

## OR if your platform has prebuilt binaries in <https://codeberg.org/ordinarylabs/Ordinary/releases>
cargo binstall ordinary@0.11.1
```

### Homebrew

```sh
## add the ordinarylabs tap
brew tap ordinarylabs/tap --custom-remote https://codeberg.org/ordinarylabs/homebrew-tap

## trust the ordinarylabs tap
brew trust ordinarylabs/tap

## supported for `aarch64-apple-darwin`, `aarch64-unknown-linux-gnu`, `x86_64-unknown-linux-gnu`
brew install ordinary
```

## Setup

```sh
## install system components
ordinary doctor --fix wasm,exiftool
```

## Quick Start

Create and build new project `example.com`.

```sh
ordinary app new example.com 
ordinary app build -p example.com
```

Run new project at <http://localhost:4433>.

```sh
ordinary app start -p example.com --insecure --stdio-logs
```

## CLI Documentation

```sh
ordinary --help
```

See: [docs/cli-reference.md](https://codeberg.org/ordinarylabs/Ordinary/src/branch/main/core/apps/cli/docs/cli-reference.md).

## CLI Completions

Add this line to your `.zshrc`, `.bashrc`, etc. to gain support for dynamic tab completions. 

```sh
## ~/.bashrc
eval "$(COMPLETE='bash' ordinary)"

## ~/.zshrc
eval "$(COMPLETE='zsh' ordinary)"
```

See: [clap_complete](https://docs.rs/clap_complete/latest/clap_complete/env/index.html).

## License

Copyright 2026 The Ordinary Authors

Licensed under [`BSD-3-Clause`](https://codeberg.org/ordinarylabs/Ordinary/src/branch/main/LICENSE)

## Security

THIS CODE HAS NOT BEEN AUDITED OR REVIEWED. USE AT YOUR OWN RISK.

Refer to the [Security Policy](https://codeberg.org/ordinarylabs/Ordinary/src/branch/main/SECURITY.md).