WorkspaceSandbox
Ajouté dans : @mastra/core@1.1.0
L'interface WorkspaceSandbox définit la manière dont les Workspaces exécutent des commandes et gèrent les processus en arrière-plan.
PropriétésLien direct vers Propriétés
processes?:
SandboxProcessManager
Gestionnaire des processus en arrière-plan. S'il n'est pas implémenté, les Tools de gestion des processus ne seront pas disponibles. Consultez la référence de SandboxProcessManager.
MéthodesLien direct vers Méthodes
start()Lien direct vers start
Démarre le Sandbox. Cette méthode est appelée automatiquement par workspace.init() ou lors du premier appel à executeCommand().
await sandbox.start()
Cette méthode prépare le Sandbox à l'exécution de commandes.
stop()Lien direct vers stop
Arrête le Sandbox.
await sandbox.stop?.()
destroy()Lien direct vers destroy
Nettoie les ressources du Sandbox. Cette méthode est appelée par workspace.destroy().
await sandbox.destroy()
executeCommand(command, args?, options?)Lien direct vers executecommandcommand-args-options
Exécute une commande shell.
const result = await sandbox.executeCommand('ls', ['-la', '/docs'])
const result = await sandbox.executeCommand('npm', ['install', 'lodash'])
Paramètres :
command:
string
Commande à exécuter
args?:
string[]
Arguments de la commande
options?:
Options
Options de configuration.
Options
timeout?:
number
Délai d'expiration de l'exécution, en millisecondes
cwd?:
string
Répertoire de travail de la commande
env?:
Record<string, string>
Variables d'environnement supplémentaires
onStdout?:
(data: string) => void
Fonction de rappel pour le flux de sortie standard
onStderr?:
(data: string) => void
Fonction de rappel pour le flux d'erreur standard
getInfo()Lien direct vers getinfo
Renvoie l'état du Sandbox et les informations sur ses ressources.
const info = await sandbox.getInfo()
// { status: 'running', resources: { memoryMB: 512, cpuPercent: 5 } }
getInstructions(opts?)Lien direct vers getinstructionsopts
Renvoie une description du fonctionnement de ce Sandbox. Elle est injectée dans le message système de l'Agent lorsque le Workspace lui est attribué.
const instructions = sandbox.getInstructions?.()
// 'Local command execution. Working directory: "/workspace".'
Paramètres :
opts.requestContext?:
RequestContext
Transmis à la fonction
instructions si celle-ci a été fournie au constructeur.Renvoie : string