SystemPromptGenerator

Struct SystemPromptGenerator 

Source
pub struct SystemPromptGenerator { /* private fields */ }
Available on crate feature cli-integration only.
Expand description

System prompt generator with output style support.

§System Prompt Structure

The generated system prompt follows this structure:

  1. CLI Identity (required for CLI OAuth authentication)

    • “You are Claude Code, Anthropic’s official CLI for Claude.”
    • This MUST be included when using CLI OAuth and cannot be replaced
  2. Base System Prompt (always included after identity)

    • Tone and style, professional objectivity, task management
  3. Tool Usage Policy (always included)

    • Tool-specific guidelines
  4. Coding Instructions (if keep_coding_instructions: true)

    • Software engineering instructions
    • Git commit/PR protocols
  5. Custom Prompt (if output style has custom content)

    • Style-specific instructions
  6. Environment Block (always included)

    • Working directory, platform, model info

Implementations§

Source§

impl SystemPromptGenerator

Source

pub fn new() -> Self

Create a new generator with default style. CLI identity is NOT required by default.

Source

pub fn with_cli_identity() -> Self

Create a generator that requires CLI identity. Use this when using Claude CLI OAuth authentication.

Source

pub fn require_cli_identity(self, required: bool) -> Self

Set whether CLI identity is required. CLI identity MUST be included when using Claude CLI OAuth.

Source

pub fn with_style(self, style: OutputStyle) -> Self

Set the output style directly.

Source

pub fn with_working_dir(self, dir: impl Into<PathBuf>) -> Self

Set the working directory for environment block.

Source

pub fn with_model(self, model_id: impl Into<String>) -> Self

Set the model information.

Source

pub fn with_model_name(self, name: impl Into<String>) -> Self

Set the model name explicitly.

Source

pub async fn with_style_name(self, name: &str) -> Result<Self>

Load and set an output style by name.

Searches in priority order:

  1. Project styles (.claude/output-styles/) - highest priority
  2. User styles (~/.claude/output-styles/)
  3. Built-in styles - lowest priority
Source

pub fn generate(&self) -> String

Generate the system prompt.

§Prompt Assembly Logic
  • CLI Identity: Only if require_cli_identity: true (CLI OAuth)
  • Base System Prompt: Always included
  • Tool Usage Policy: Always included
  • Coding Instructions: Only if keep_coding_instructions: true
  • Custom Prompt: Only if style has non-empty prompt
  • Environment Block: Always included
Source

pub fn generate_with_context(&self, additional_context: &str) -> String

Generate the system prompt with additional dynamic context.

This is used when rules or other dynamic content needs to be appended.

Source

pub fn style(&self) -> &OutputStyle

Get the current output style.

Source

pub fn has_coding_instructions(&self) -> bool

Check if coding instructions are included.

Trait Implementations§

Source§

impl Clone for SystemPromptGenerator

Source§

fn clone(&self) -> SystemPromptGenerator

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 SystemPromptGenerator

Source§

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

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

impl Default for SystemPromptGenerator

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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