Enum Commands

Source

pub enum Commands {
Show 33 variants    Auth {
        cmd: AuthCmd,
    },
    Install {
        target: String,
    },
    Init {
        repository: Option<String>,
        provider: Option<String>,
        remote_url: Option<String>,
        workspace_id: Option<String>,
        remote: Option<String>,
        reset: bool,
    },
    Configure {
        args: ConfigureArgs,
    },
    Choose {
        cmd: ChooseCmd,
    },
    Backend {
        cmd: BackendCmd,
    },
    Completions {
        shell: Shell,
    },
    Doctor {
        repair: bool,
    },
    Status,
    Sync {
        repository: String,
    },
    Create {
        entity_type: String,
        entity_id: String,
        repository: String,
        name: String,
        author: String,
    },
    Resolve {
        uri: String,
        branch: Option<String>,
        commit: Option<String>,
        format: String,
        provenance: bool,
        include_blobs: bool,
    },
    Presign {
        uri: String,
        representation: String,
        branch: Option<String>,
        commit: Option<String>,
        ttl_seconds: Option<u64>,
        http_url: Option<String>,
        token_env: Option<String>,
    },
    Query {
        uri: String,
        path: String,
        format: String,
    },
    Commit {
        repository: String,
        message: String,
        author: String,
    },
    History {
        uri: String,
        limit: usize,
    },
    List {
        repository: Option<String>,
        entity_type: Option<String>,
    },
    Branch {
        repository: String,
        name: Option<String>,
    },
    Set {
        uri: String,
        key: String,
        value: String,
        message: String,
        author: String,
    },
    Add {
        uri: String,
        key: String,
        file: PathBuf,
        format: String,
        message: String,
        author: String,
    },
    Revert {
        repository: String,
        commit: String,
        author: String,
    },
    Pull {
        url_or_name: String,
    },
    Push {
        repository: String,
        remote: String,
        branch: Option<String>,
    },
    Remote(RemoteCmd),
    Sign {
        uri: String,
    },
    Verify {
        uri: String,
    },
    Switch {
        repository: String,
        name: String,
    },
    Head {
        repository: String,
    },
    Validate {
        uri: Option<String>,
        file: Option<PathBuf>,
    },
    Schema {
        name: String,
        format: String,
    },
    Diff {
        base_file: PathBuf,
        candidate_file: PathBuf,
        format: String,
    },
    Merge {
        base: PathBuf,
        current: PathBuf,
        proposed: PathBuf,
        format: String,
    },
    ContentHash {
        file: PathBuf,
    },
}

Variants§

§

Auth

Manage secure authentication for the configured Lore provider.

Fields

§cmd: AuthCmd

Authentication operation.

§

Install

Install required dependencies.

Fields

§target: String

Target to install (e.g., “lore” or “mcp”).

§

Init

Initialize a repository repository and/or configure the backend provider.

When a repository name is provided, creates the repository structure (directories, config, repository manifest, initial commit). When –provider is given (or no provider is configured), sets up the backend provider. Both can be combined:

px init toystory # create repository px init toystory –provider local # create repository + configure provider px init –provider local # configure provider only

Fields

§repository: Option<String>

Repository name. If provided, initializes a new repository repository.

§provider: Option<String>

Provider type: local, portals-cloud, or remote.

§remote_url: Option<String>

Remote URL (required for remote provider).

§workspace_id: Option<String>

Workspace ID (for remote provider).

§remote: Option<String>

Remote URL to add as origin after init.

This is deliberately --origin: --remote selects server-backed reads globally and must remain unambiguous on every command.

§reset: bool

Reset the provider configuration file.

§

Configure

Configure version-control backend (unified: replaces px choose + px backend).

Examples: px configure # show current config px configure status # show current config px configure local # switch to local daemon px configure remote –remote-url lore://192.168.0.27:41337 px configure portals-cloud –workspace-id my-ws px configure –provider remote –remote-url lore://host:41337 –reset

Fields

§args: ConfigureArgs

§

Choose

Choose backend provider (deprecated: use px configure).

Fields

§cmd: ChooseCmd

Subcommand for choose.

§

Backend

Configure or inspect the version-control backend (deprecated: use px configure).

Fields

§cmd: BackendCmd

Subcommand for backend.

§

Completions

Generate shell completions for px.

Usage: px completions bash > ~/.local/share/bash-completion/completions/px px completions zsh > ~/.zfunc/_px px completions fish > ~/.config/fish/completions/px.fish source <(px completions bash) # ephemeral

Fields

§shell: Shell

Shell to generate completions for.

§

Doctor

Run diagnostics and repair.

Fields

§repair: bool

Auto-repair detected issues.

§

Status

Show system status.

§

Sync

Sync with remote.

Fields

§repository: String

Repository name.

§

Create

Create a new entity manifest.

Fields

§entity_type: String

Entity type (any non-empty string, e.g. character, location, custom-type).

§entity_id: String

Entity ID (slug). e.g., “woody”.

§repository: String

Repository name.

§name: String

Human-readable name.

§author: String

Author identifier.

§

Resolve

Resolve a PX URI to its manifest or a subtree.

Fragment queries are supported via the URI: px resolve px://toystory/character/woody#references.appears_in

Fields

§uri: String

PX URI. e.g., “px://toystory/character/woody”

§branch: Option<String>

Resolve at a specific branch.

§commit: Option<String>

Resolve at a specific commit hash.

§format: String

Output format: yaml, json.

§provenance: bool

Include condensed per-file provenance for the manifest and direct representations.

§include_blobs: bool

Hydrate known readable provenance artifacts such as prompts and run records.

§

Presign

Create a time-limited public URL for a committed representation.

Fields

§uri: String

Entity ID, e.g. 25th-chapter/character/nathan-gunn. The px:// prefix is optional; fragments are not supported.

§representation: String

Representation name (manifest key), e.g. item. Its URI is relative to the entity’s asset directory.

§branch: Option<String>

Resolve at a specific branch.

§commit: Option<String>

Resolve at a specific commit hash.

§ttl_seconds: Option<u64>

Requested lifetime in seconds; Lore enforces its configured bounds.

§http_url: Option<String>

Explicit Lore HTTP origin, such as http://127.0.0.1:41339.

§token_env: Option<String>

Environment variable containing a repository-scoped bearer token.

§

Query

Query a subtree from a manifest.

Fields

§uri: String

PX URI.

§path: String

Dot-notation path. e.g., “appearances.audienceVotes”.

§format: String

Output format: yaml, json.

§

Commit

Commit changes to a repository repository.

Fields

§repository: String

Repository name.

§message: String

Commit message.

§author: String

Author identifier.

§

History

View commit history for an entity.

Fields

§uri: String

PX URI.

§limit: usize

Maximum number of commits to show.

§

List

List repositories or entities within a repository.

Fields

§repository: Option<String>

Repository name. Omit to list all repositories.

§entity_type: Option<String>

Entity type to list (if repository is specified).

§

Branch

Create or list branches.

Fields

§repository: String

Repository name.

§name: Option<String>

Branch name to create. Omit to list all branches.

§

Set

Set a property on an entity manifest.

Fields

§uri: String

PX URI.

§key: String

Property key (dot-notation).

§value: String

Property value.

§message: String

Commit message.

§author: String

Author identifier.

§

Add

Add a file representation to an entity manifest.

Fields

§uri: String

PX URI.

§key: String

Representation key. e.g., “reference_image”.

§file: PathBuf

File path to the asset.

§format: String

Asset format. e.g., “png”, “glb”.

§message: String

Commit message.

§author: String

Author identifier.

§

Revert

Revert a commit by hash (undoes all changes in that commit).

Fields

§repository: String

Repository name.

§commit: String

Commit hash to revert.

§author: String

Author identifier.

§

Pull

Clone or pull a repository from a remote.

If the argument is a URL, the repo is cloned (name is read from the repo’s own config). If it’s a repository name, the repo must already exist locally and will be updated via pull.