nf

nf Documentation

nf is nonfiction’s internal CLI for agency WordPress theme work. It manages project metadata, local WordPress dev environments, theme tasks and packaging, provider inventory, repo remotes, password derivation, and guarded future deploy/sync workflows.

This documentation expands on the concise repo README. For the full project model, state layout, implementation phases, and roadmap, see SPEC.md.

Start Here

• Usage: workflow map for common agency work.
• Installation: install, run, build, shell completion, and releases.
• Configuration: global config, secrets, provider tokens, password derivation, and test isolation paths.

Practical Guides

• Local Development: spin up a local WordPress env from a repo.
• Targets: add and inspect deployable targets.
• Sites: add remote WordPress sites and inspect envs.
• Staging: create, inspect, and remove staging envs.
• Remotes: connect a repo to a cached remote env.
• Themes: run theme tasks, package releases, deploy, and rollback.
• Aliases: expose root-level symlinks to paths under wp-content.
• Plugins: configure, compare, and install WordPress plugins.
• Snapshots: create, import, restore, prune, and remove env snapshots.
• Sync: push or pull database and mutable wp-content with reviewable preflights.
• Domains and Launch: manage public domains and launch a primary domain.

Reference

• Commands: command groups, provider/target/site/domain/remotes reference, and current behavior notes.
• Deployment: deployment workflow overview and links to detailed guides.
• Development: development commands, tests, Nix checks, release builds, and contributor caveats.
• Architecture: repository shape, state/cache layout, project model, provider model, and safety boundaries.

First Steps

nix profile add github:nonfiction/nf
nf config init
nf password set-salt <shared-salt>
nf init
nf env up

After nf init, run project-local commands from that repo so theme, env, plugin, alias, and remote are available.