GenerateOptions

Struct GenerateOptions 

Source
pub struct GenerateOptions {
    pub project_root: Option<PathBuf>,
    pub file: PathBuf,
    pub tag: String,
    pub num_tasks: u32,
    pub no_expand: bool,
    pub no_check_deps: bool,
    pub append: bool,
    pub no_guidance: bool,
    pub id_format: String,
    pub model: Option<String>,
    pub dry_run: bool,
    pub verbose: bool,
}
Expand description

Options for the task generation pipeline.

This struct configures the multi-phase task generation process:

  1. Parse: Convert a PRD document into initial tasks
  2. Expand: Break down complex tasks into subtasks
  3. Check Dependencies: Validate and fix task dependencies

§Example

use scud::commands::generate::{generate, GenerateOptions};
use std::path::PathBuf;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let options = GenerateOptions::new(
        PathBuf::from("docs/prd.md"),
        "my-feature".to_string(),
    );

    generate(options).await?;
    Ok(())
}

Fields§

§project_root: Option<PathBuf>

Project root directory (None for current directory)

§file: PathBuf

Path to the PRD/spec document to parse

§tag: String

Tag name for generated tasks

§num_tasks: u32

Number of tasks to generate (default: 10)

§no_expand: bool

Skip task expansion phase

§no_check_deps: bool

Skip dependency validation phase

§append: bool

Append tasks to existing tag instead of replacing

§no_guidance: bool

Skip loading guidance from .scud/guidance/

§id_format: String

Task ID format: “sequential” (default) or “uuid”

§model: Option<String>

Model to use for AI operations (overrides config)

§dry_run: bool

Show what would be done without making changes

§verbose: bool

Verbose output showing each phase’s details

Implementations§

Source§

impl GenerateOptions

Source

pub fn new(file: PathBuf, tag: String) -> Self

Create new options with required fields and sensible defaults.

§Arguments
  • file - Path to the PRD/spec document
  • tag - Tag name for the generated tasks

Trait Implementations§

Source§

impl Clone for GenerateOptions

Source§

fn clone(&self) -> GenerateOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for GenerateOptions

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for GenerateOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more