Skip to main content

Crate radial

Crate radial 

Source
Expand description

Radial is a task orchestration library for breaking goals into tracked, verifiable tasks connected by contracts.

The public API is the domain vocabulary (see models) plus the operations that act on it (see ops): construct or open a Database, then drive it through ops functions such as ops::goal::create and ops::task::start.

The rd binary built from this crate is a thin CLI shell over the same ops functions; it is not part of the published surface.

Re-exports§

pub use db::Database;
pub use db::DbLock;
pub use id::GoalId;
pub use id::TaskId;
pub use models::Comment;
pub use models::Contract;
pub use models::Goal;
pub use models::GoalState;
pub use models::Metrics;
pub use models::Outcome;
pub use models::Priority;
pub use models::Task;
pub use models::TaskMetrics;
pub use models::TaskState;
pub use ops::task::CompleteResult;

Modules§

db
Persistence layer: the Database handle, file locking, and directory discovery.
duration
Parsing of human-readable stale-duration strings (e.g. "2h", "30m").
id
Identifier types for goals and tasks.
models
Domain types: models::Goal, models::Task, and the values they are built from.
ops
Pure operations on a Database that implement the library’s supported API.

Constants§

RADIAL_DIR
Name of the directory radial stores its state in, relative to a project root.

Functions§

find_radial_dir
Finds the .radial/ directory by walking up from from. Returns None if no .radial/ directory is found.
resolve_radial_dir
Resolves the final radial directory, following any redirect file. A redirect file contains a path (absolute or relative) to another .radial/ directory.
run_cli
Parses CLI arguments and dispatches to the appropriate command.