Search Results for

    Show / Hide Table of Contents

    Class ShellCommandCallManager

    Manages and executes local shell commands that can be called by AI agents.

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    ToolCallManagerBase<LocalShellCall, LocalShellOutput>
    ShellCommandCallManager
    Implements
    ILocalShellExecutor
    IToolCallExecutor<LocalShellCall, LocalShellOutput>
    Inherited Members
    ToolCallManagerBase<LocalShellCall, LocalShellOutput>.ValidateCall(LocalShellCall)
    ToolCallManagerBase<LocalShellCall, LocalShellOutput>.ExecuteAsync(LocalShellCall, CancellationToken)
    ToolCallManagerBase<LocalShellCall, LocalShellOutput>.ExecuteAsyncInternal(LocalShellCall, CancellationToken)
    ToolCallManagerBase<LocalShellCall, LocalShellOutput>.CreateErrorOutput(LocalShellCall, Exception)
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(string, float)
    MonoBehaviour.InvokeRepeating(string, float, float)
    MonoBehaviour.CancelInvoke(string)
    MonoBehaviour.IsInvoking(string)
    MonoBehaviour.StartCoroutine(string)
    MonoBehaviour.StartCoroutine(string, object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StartCoroutine_Auto(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(string)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(object)
    MonoBehaviour.destroyCancellationToken
    MonoBehaviour.useGUILayout
    MonoBehaviour.didStart
    MonoBehaviour.didAwake
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, out Component)
    Component.TryGetComponent<T>(out T)
    Component.GetComponent(string)
    Component.GetComponentInChildren(Type, bool)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(bool)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, bool)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(bool)
    Component.GetComponentsInChildren<T>(bool, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type, bool)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>(bool)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, bool)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(bool)
    Component.GetComponentsInParent<T>(bool, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.GetComponentIndex()
    Component.CompareTag(string)
    Component.CompareTag(TagHandle)
    Component.SendMessageUpwards(string, object, SendMessageOptions)
    Component.SendMessageUpwards(string, object)
    Component.SendMessageUpwards(string)
    Component.SendMessageUpwards(string, SendMessageOptions)
    Component.SendMessage(string, object)
    Component.SendMessage(string)
    Component.SendMessage(string, object, SendMessageOptions)
    Component.SendMessage(string, SendMessageOptions)
    Component.BroadcastMessage(string, object, SendMessageOptions)
    Component.BroadcastMessage(string, object)
    Component.BroadcastMessage(string)
    Component.BroadcastMessage(string, SendMessageOptions)
    Component.transform
    Component.transformHandle
    Component.gameObject
    Component.tag
    Object.GetEntityId()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.InstantiateAsync<T>(T)
    Object.InstantiateAsync<T>(T, Transform)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int)
    Object.InstantiateAsync<T>(T, int, Transform)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)
    Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Scene)
    Object.Instantiate<T>(T, InstantiateParameters)
    Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Glitch9.AIDevKit.Agents
    Assembly: Glitch9.AIDevKit.Agent.dll
    Syntax
    [AddComponentMenu("AI DevKit/AI Agents/Shell Command Call Manager", 22)]
    public class ShellCommandCallManager : ToolCallManagerBase<LocalShellCall, LocalShellOutput>, ILocalShellExecutor, IToolCallExecutor<LocalShellCall, LocalShellOutput>

    Methods

    | Edit this page View Source

    CanExecute(string)

    Returns true if the given key is present in the registered command keys whitelist.

    Declaration
    public bool CanExecute(string key)
    Parameters
    Type Name Description
    string key

    The command key to look up (case-insensitive).

    Returns
    Type Description
    bool
    | Edit this page View Source

    CreateErrorOutput(LocalShellCall, Exception)

    Declaration
    protected override LocalShellOutput CreateErrorOutput(LocalShellCall call, Exception ex)
    Parameters
    Type Name Description
    LocalShellCall call
    Exception ex
    Returns
    Type Description
    LocalShellOutput
    Overrides
    ToolCallManagerBase<LocalShellCall, LocalShellOutput>.CreateErrorOutput(LocalShellCall, Exception)
    | Edit this page View Source

    ExecuteAsyncInternal(LocalShellCall, CancellationToken)

    Executes the shell command specified in the call and returns the resulting output.

    Declaration
    protected override UniTask<LocalShellOutput> ExecuteAsyncInternal(LocalShellCall call, CancellationToken ct)
    Parameters
    Type Name Description
    LocalShellCall call

    The local shell call to execute.

    CancellationToken ct

    Cancellation token.

    Returns
    Type Description
    UniTask<LocalShellOutput>

    A LocalShellOutput with the command result, or an incomplete output on error.

    Overrides
    ToolCallManagerBase<LocalShellCall, LocalShellOutput>.ExecuteAsyncInternal(LocalShellCall, CancellationToken)
    | Edit this page View Source

    ValidateCall(LocalShellCall)

    Validates that the call contains a non-null action and that command keys are registered.

    Declaration
    protected override void ValidateCall(LocalShellCall call)
    Parameters
    Type Name Description
    LocalShellCall call

    The local shell call to validate.

    Overrides
    ToolCallManagerBase<LocalShellCall, LocalShellOutput>.ValidateCall(LocalShellCall)
    Exceptions
    Type Condition
    ArgumentNullException

    Thrown when the call or its action is null.

    InvalidOperationException

    Thrown when no command keys are registered.

    Implements

    ILocalShellExecutor
    IToolCallExecutor<TCall, TOutput>

    Extension Methods

    LocalizationExtensions.SetLocalizedAsset<TComponent, TObject>(TComponent, string, Action<TComponent, TObject>, string, LocalizationOptions<TObject>)
    ArrayExtensions.ToArrayOrEmpty<T>(T)
    ArrayExtensions.ToArrayOrNull<T>(T)
    EventExtensions.ToDelta<T>(T, string, int, string, bool)
    EventExtensions.ToDone<T>(T, string, int, string)
    EventExtensions.ToEvent<T>(T)
    EventExtensions.UpcastDelta<T1, T2>(T1, string, int, string, bool)
    FallbackExtensions.IsOr<TParent, TChild>(TParent, TChild)
    FileExtensions.ToFile<T>(T, string)
    ResponseCastingExtensions.GetResult<T>(T)
    UnityObjectExtensions.Find<T>(T, string)
    UnityObjectExtensions.Find<T, TTarget>(TTarget, T, string)
    UnityObjectExtensions.Find<T, TTarget>(TTarget, T, string, string)
    UnityObjectExtensions.GetChildIndex<T>(T)
    UnityObjectExtensions.GetOrAddComponentInChildren<T, TV>(TV, string)
    SystemExtensions.GetName(object)
    UnityObjectExtensions.EncodeToBase64(Object)
    UnityObjectExtensions.ToBytes(Object)
    • Edit this page
    • View Source
    In this article
    Back to top AI DevKit Documentation