Skip to main content

Crate ordinary

Crate ordinary 

Source
Expand description

§Command-Line Help for ordinary

This document contains the help content for the ordinary command-line program.

Command Overview:

§ordinary

Ordinary CLI

Usage: ordinary [OPTIONS] <COMMAND>

§Subcommands:
  • new — create a new Ordinary project
  • build — build your Ordinary project
  • templates — manage templates in your Ordinary project
  • content — manage content in your Ordinary project
  • assets — manage assets in your Ordinary project
  • models — manage models in your Ordinary project
  • actions — manage actions in your Ordinary project
  • integrations — manage integrations in your Ordinary project
  • accounts — manage accounts connected to ordinaryd
  • app — manage applications running on ordinaryd
§Options:

  • -v, --verbose — Increase logging verbosity

  • -q, --quiet — Decrease logging verbosity

  • --pretty — whether to pretty print events to stdio

    Default value: false

  • -p, --project <PROJECT> — project path

    Default value: .

  • --insecure — use HTTP instead of HTTPS

    Default value: false

  • --host-domain <HOST_DOMAIN> — should only be necessary with localhost or when addressing by IP

  • --danger-accept-invalid-certs — DANGER: only use when working with self-signed localhost certs

    Default value: false

§ordinary new

create a new Ordinary project

Usage: ordinary new <PATH> <DOMAIN>

§Arguments:
  • <PATH> — project path
  • <DOMAIN> — project domain

§ordinary build

build your Ordinary project

Usage: ordinary build [OPTIONS]

§Options:

  • -i, --ignore-cache — build project without checking the cache

    Default value: false

§ordinary templates

manage templates in your Ordinary project

Usage: ordinary templates <COMMAND>

§Subcommands:
  • add — add a new template to the Ordinary project
  • put — upload templates to application running on ordinaryd instance

§ordinary templates add

add a new template to the Ordinary project

Usage: ordinary templates add <NAME> <ROUTE> <MIME>

§Arguments:
  • <NAME> — template name
  • <ROUTE> — HTTP route (must start with leading “/”)
  • <MIME> — MIME type for template output: reference

§ordinary templates put

upload templates to application running on ordinaryd instance

Usage: ordinary templates put [OPTIONS]

§Options:
  • -n, --name <NAME> — name of a specific template to upload (optional). will upload all when the --name flag is not passed

§ordinary content

manage content in your Ordinary project

Usage: ordinary content <COMMAND>

§Subcommands:
  • definition — manage content definitions for Ordinary project
  • object — manage content objects for Ordinary project
  • put — update content for application running on ordinaryd instance

§ordinary content definition

manage content definitions for Ordinary project

Usage: ordinary content definition <COMMAND>

§Subcommands:
  • add — add a content definition to your Ordinary project

§ordinary content definition add

add a content definition to your Ordinary project

Usage: ordinary content definition add <NAME>

§Arguments:
  • <NAME> — content definition / instance name

§ordinary content object

manage content objects for Ordinary project

Usage: ordinary content object <COMMAND>

§Subcommands:
  • add — add a content object to your Ordinary project

§ordinary content object add

add a content object to your Ordinary project

Usage: ordinary content object add <JSON>

§Arguments:
  • <JSON> — json value of content object

§ordinary content put

update content for application running on ordinaryd instance

Usage: ordinary content put

§ordinary assets

manage assets in your Ordinary project

Usage: ordinary assets <COMMAND>

§Subcommands:
  • put — write assets to application running on ordinaryd instance

§ordinary assets put

write assets to application running on ordinaryd instance

Usage: ordinary assets put [OPTIONS]

§Options:
  • -n, --name <NAME> — name of a specific asset to write (optional). will write all when the --name flag is not passed

§ordinary models

manage models in your Ordinary project

Usage: ordinary models <COMMAND>

§Subcommands:
  • add — add a new model to your Ordinary project
  • items — manage model items for the application running on an ordinaryd instance

§ordinary models add

add a new model to your Ordinary project

Usage: ordinary models add <NAME> [UUID_VERSION]

§Arguments:

  • <NAME> — name of the model

  • <UUID_VERSION> — UUID version

    Possible values: v4, v7

§ordinary models items

manage model items for the application running on an ordinaryd instance

Usage: ordinary models items <COMMAND>

§Subcommands:
  • list — list model items for the application running on an ordinaryd instance

§ordinary models items list

list model items for the application running on an ordinaryd instance

Usage: ordinary models items list [OPTIONS] <NAME>

§Arguments:
  • <NAME> — name of the model
§Options:

  • --json — for applications that need to consume stdio or pipe to jq

    Default value: false

§ordinary actions

manage actions in your Ordinary project

Usage: ordinary actions <COMMAND>

§Subcommands:
  • add — add a new action to your Ordinary project
  • put — install actions to application running on ordinaryd instance

§ordinary actions add

add a new action to your Ordinary project

Usage: ordinary actions add <NAME> <LANG> [TRANSACTIONAL]

§Arguments:

  • <NAME> — action name

  • <LANG> — language the action runs

  • <TRANSACTIONAL> — whether the action is transactional

    Possible values: true, false

§ordinary actions put

install actions to application running on ordinaryd instance

Usage: ordinary actions put [OPTIONS]

§Options:
  • -n, --name <NAME> — name of a specific action to install (optional). will install all when the --name flag is not passed

§ordinary integrations

manage integrations in your Ordinary project

Usage: ordinary integrations <COMMAND>

§Subcommands:
  • add — add a new integration to your Ordinary project

§ordinary integrations add

add a new integration to your Ordinary project

Usage: ordinary integrations add <NAME> <ENDPOINT> <PROTOCOL>

§Arguments:

  • <NAME> — name of the integration

  • <ENDPOINT> — url endpoint for integration

  • <PROTOCOL> — protocol for the integration

    Possible values: JSON

§ordinary accounts

manage accounts connected to ordinaryd

Usage: ordinary accounts <COMMAND>

§Subcommands:
  • register — register a new account
  • login — log in to an existing account
  • logout — log out of a logged in account
  • access — access management subcommands
  • password — password management
  • invite — invite another user to a project
  • current — display info for current account
  • list — list all logged in accounts
  • switch — switch to a different logged in account

§ordinary accounts register

register a new account

Usage: ordinary accounts register [OPTIONS] <HOST> <ACCOUNT>

§Arguments:
  • <HOST> — url where orindaryd is running
  • <ACCOUNT> — name of your account with the host
§Options:
  • --password <PASSWORD> — password for your new account
  • --invite <INVITE> — base64 encoded invite token

§ordinary accounts login

log in to an existing account

Usage: ordinary accounts login [OPTIONS] <HOST> <ACCOUNT>

§Arguments:
  • <HOST> — url where orindaryd is running
  • <ACCOUNT> — name of your account with the host
§Options:
  • --password <PASSWORD> — password for your existing account
  • --mfa <MFA> — 6 digit TOTP MFA code

§ordinary accounts logout

log out of a logged in account

Usage: ordinary accounts logout

§ordinary accounts access

access management subcommands

Usage: ordinary accounts access <COMMAND>

§Subcommands:
  • get — get access

§ordinary accounts access get

get access

Usage: ordinary accounts access get [OPTIONS]

§Options:
  • -m, --min <MIN> — how long the client signature is valid for

§ordinary accounts password

password management

Usage: ordinary accounts password <COMMAND>

§Subcommands:
  • reset — reset your password

§ordinary accounts password reset

reset your password

Usage: ordinary accounts password reset [OPTIONS]

§Options:
  • --password <PASSWORD> — existing password
  • --new-password <NEW_PASSWORD> — new password to be set
  • --mfa <MFA> — 6 digit TOTP MFA code

§ordinary accounts invite

invite another user to a project

Usage: ordinary accounts invite <ACCOUNT> [PERMISSIONS]...

§Arguments:

  • <ACCOUNT> — name of the account to be invited & registered

  • <PERMISSIONS> — which permissions to include in their set

    Possible values: admin, read, write, update, upload, install, deploy, bridge, kill, erase

§ordinary accounts current

display info for current account

format:

Usage: ordinary accounts current

§ordinary accounts list

list all logged in accounts

Usage: ordinary accounts list

§ordinary accounts switch

switch to a different logged in account

Usage: ordinary accounts switch <HOST> <ACCOUNT>

§Arguments:
  • <HOST> — location where orindaryd is running
  • <ACCOUNT> — name of the account you’d like to switch to

§ordinary app

manage applications running on ordinaryd

Usage: ordinary app <COMMAND>

§Subcommands:
  • deploy — deploy a new application
  • patch — push a configuration level change
  • migrate — push a configuration change which will modify the shape of your data stores
  • kill — kill a running instance of the application
  • download — download an application as static files
  • logs — query application logs
  • accounts — manage application accounts

§ordinary app deploy

deploy a new application

Usage: ordinary app deploy

§ordinary app patch

push a configuration level change

Usage: ordinary app patch

§ordinary app migrate

push a configuration change which will modify the shape of your data stores

(i.e. a structural change to model or content definitions)

Usage: ordinary app migrate

§ordinary app kill

kill a running instance of the application

Usage: ordinary app kill

§ordinary app download

download an application as static files

Usage: ordinary app download [OPTIONS]

§Options:

  • -u, --url <URL> — url override. will use project domain by default

  • -o, --out <OUT> — where to store downloaded files

    Default value: out

§ordinary app logs

query application logs

Usage: ordinary app logs [OPTIONS] <FORMAT> <QUERY>

§Arguments:

  • <FORMAT> — format

    Possible values: all, top, count

  • <QUERY> — reference

§Options:

  • --limit <LIMIT> — limit (when using ‘top’ format)

  • --json — for applications that need to consume stdio or pipe to jq

    Default value: false

§ordinary app accounts

manage application accounts

Usage: ordinary app accounts <COMMAND>

§Subcommands:
  • list — list application accounts

§ordinary app accounts list

list application accounts

Usage: ordinary app accounts list [OPTIONS]

§Options:

  • --json — for applications that need to consume stdio or pipe to jq

    Default value: false

This document was generated automatically by clap-markdown.

Structs§

Cli
Globals

Enums§

Accounts
account management subcommands
Actions
App
Assets
Commands
Content
Integrations
Models
Permission
permission for app operations on the Ordinary Server
Templates

Functions§

run
setup