Skip to main content

Permission

Enum Permission 

Source
pub enum Permission {
    ReadOnly,
    Plan,
    Edit,
    Auto,
    Bypass,
}
Expand description

Permission posture for a run, mapped onto each agent’s own vocabulary.

§What these do and do not guarantee

These postures constrain each CLI’s built-in tools: its shell, its file writes, its sandbox. They do not constrain MCP servers, plugins or custom tools the agent is configured with. An MCP tool that files an issue, writes to a database or calls a deployment API is a separate tool category in all three CLIs and can still act during a nominally restricted run.

If a run must not cause remote side effects, the containment has to come from the agent’s own configuration (which MCP servers are enabled at all), not from this enum. What is selected here is enforced by the CLI, and what the CLI does not model cannot be enforced from out here.

Variants§

§

ReadOnly

No writes to the local filesystem, and no shell where the CLI can gate one.

The strongest posture this crate can express, and still not a guarantee of “no side effects”: see the type-level note about MCP tools. Codex enforces it with a read-only sandbox, which blocks writes but still permits command execution.

§

Plan

Ask the agent to plan rather than act.

Claude and Copilot have a real plan mode. Codex has none, so this maps to its read-only sandbox: writes are blocked, but the model is not instructed to withhold execution the way a true plan mode would.

§

Edit

Allow file edits, while still gating shell commands where the CLI can.

§

Auto

Allow the agent’s own default automation.

§

Bypass

Skip every permission check. For sandboxes.

Trait Implementations§

Source§

impl Clone for Permission

Source§

fn clone(&self) -> Permission

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Permission

Source§

impl Debug for Permission

Source§

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

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

impl Default for Permission

Source§

fn default() -> Permission

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

impl<'de> Deserialize<'de> for Permission

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for Permission

Source§

impl PartialEq for Permission

Source§

fn eq(&self, other: &Permission) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for Permission

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Permission

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.