Struct IntelliShellService 

pub struct IntelliShellService { /* private fields */ }

Service for managing user commands in IntelliShell

Implementations

impl IntelliShellService

pub async fn fix_command<F>( &self, command: &str, history: Option<&str>, on_progress: F, ) -> Result<Option<CommandFix>>

where F: FnMut(AiFixProgress),

Tries to fix a failing command by using an AI model.

If the command was successfully executed, this method will return None.

pub async fn suggest_commands(&self, prompt: &str) -> Result<Vec<Command>>

Suggest command templates from an user prompt using an AI model

pub async fn suggest_command( &self, cmd: impl AsRef<str>, description: impl AsRef<str>, ) -> Result<Option<Command>>

Suggest a command template from a command and description using an AI model

pub async fn suggest_completion( &self, root_cmd: impl AsRef<str>, variable: impl AsRef<str>, description: impl AsRef<str>, ) -> Result<String>

Suggest a command for a dynamic completion using an AI model

impl IntelliShellService

pub async fn is_storage_empty(&self) -> Result<bool>

Returns whether the commands storage is empty

pub async fn insert_command(&self, command: Command) -> Result<Command>

Bookmarks a new command

pub async fn update_command(&self, command: Command) -> Result<Command>

Updates an existing command

pub async fn increment_command_usage(&self, command_id: Uuid) -> Result<i32>

Increases the usage of a command, returning the new usage count

pub async fn delete_command(&self, id: Uuid) -> Result<()>

Deletes an existing command

pub async fn search_tags( &self, mode: SearchMode, user_only: bool, query: &str, cursor_pos: usize, ) -> Result<Option<Vec<(String, u64, bool)>>>

Searches for tags based on a query string

pub async fn search_commands( &self, mode: SearchMode, user_only: bool, query: &str, ) -> Result<(Vec<Command>, bool)>

Searches for commands based on a query string, returning both the command and whether it was an alias match

impl IntelliShellService

pub async fn list_variable_completion_root_cmds(&self) -> Result<Vec<String>>

Lists all unique root commands for variable completions

pub async fn list_variable_completions( &self, root_cmd: Option<&str>, ) -> Result<Vec<VariableCompletion>>

Lists variable completions, optionally filtering by root command and variable name

pub async fn create_variable_completion( &self, var: VariableCompletion, ) -> Result<VariableCompletion>

Creates a new variable completion

pub async fn update_variable_completion( &self, var: VariableCompletion, ) -> Result<VariableCompletion>

Updates a variable completion

pub async fn delete_variable_completion(&self, id: Uuid) -> Result<()>

Deletes a variable completion

pub async fn delete_variable_completion_by_key( &self, root_cmd: impl AsRef<str>, variable_name: impl AsRef<str>, ) -> Result<Option<VariableCompletion>>

Deletes a variable completion by its unique key, returning it

impl IntelliShellService

pub async fn prepare_items_export( &self, filter: Option<Regex>, ) -> Result<ImportExportStream>

Prepare a stream of items to export, optionally filtering commands

pub async fn export_items( &self, items: ImportExportStream, args: ExportItemsProcess, gist_config: GistConfig, ) -> Result<ExportStats>

Exports given commands and completions

impl IntelliShellService

pub async fn import_items( &self, items: ImportExportStream, overwrite: bool, ) -> Result<ImportStats>

Import commands and completions

pub async fn get_items_from_location( &self, args: ImportItemsProcess, gist_config: GistConfig, ) -> Result<ImportExportStream>

Returns a list of items to import from a location

impl IntelliShellService

pub async fn clear_tldr_commands(&self, category: Option<String>) -> Result<u64>

Removes tldr commands matching the given criteria.

Returns the number of commands removed

pub async fn fetch_tldr_commands( &self, category: Option<String>, commands: Vec<String>, progress: Sender<TldrFetchProgress>, ) -> Result<ImportStats>

Fetches and imports tldr commands matching the given criteria

impl IntelliShellService

pub fn replace_command_variables( &self, command: String, values: Vec<(String, Option<String>)>, use_env: bool, ) -> Result<String, Vec<String>>

Replaces the variables found in a command with their values.

If one or more values are not found, they will be returned as an error.

pub async fn search_variable_suggestions( &self, flat_root_cmd: &str, variable: &Variable, context: BTreeMap<String, String>, ) -> Result<(Vec<(u8, VariableSuggestion, f64)>, Option<impl Stream<Item = (f64, Result<Vec<String>, String>)> + use<>>)>

Searches suggestions for the given variable

pub async fn insert_variable_value( &self, value: VariableValue, ) -> Result<VariableValue>

Inserts a new variable value

pub async fn update_variable_value( &self, value: VariableValue, ) -> Result<VariableValue>

Updates an existing variable value

pub async fn increment_variable_value_usage( &self, value_id: i32, context: BTreeMap<String, String>, ) -> Result<i32>

Increases the usage of a variable value, returning the new usage count

pub async fn delete_variable_value(&self, id: i32) -> Result<()>

Deletes an existing variable value

impl IntelliShellService

pub fn poll_new_version(&self) -> Option<Version>

Polls for a new version in a non-blocking manner.

This method returns immediately. On the first call, it spawns a background task to fetch the latest version. Subsequent calls will return None while the check is in progress. Once the check is finished, this method will consistently return the cached result.

pub async fn check_new_version(&self) -> Result<Option<Version>>

Checks for a new version, performing a network request if necessary.

This method performs the version check immediately, blocking the caller.

For a non-blocking alternative that spawns a background task, see poll_new_version.

impl IntelliShellService

pub fn new( storage: SqliteStorage, tuning: SearchTuning, ai: AiConfig, data_dir: impl AsRef<Path>, check_updates: bool, ) -> Self

Creates a new instance of IntelliShellService

pub async fn query(&self, sql: String) -> Result<String>

pub async fn load_workspace_items(&self) -> Result<bool>

Loads workspace commands and completions from the .intellishell file in the current working directory setting up the temporary tables in the database if they don’t exist.

Returns whether a workspace file was processed or not

Trait Implementations

impl Clone for IntelliShellService

fn clone(&self) -> IntelliShellService

Returns a duplicate of the value.

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

Performs copy-assignment from source.