Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var AddMcpCmd = &cobra.Command{ Use: "add-mcp [name] [args...]", Short: "Add an MCP server entry to agent.yaml", Long: `Add an MCP server entry to agent.yaml. Use flags for non-interactive setup or run without flags to open the wizard.`, Args: cobra.ArbitraryArgs, RunE: runAddMcp, }
View Source
var AddSkillCmd = &cobra.Command{ Use: "add-skill [name] [args...]", Short: "Add an skill to agent", Long: `Add an skill to agent. Use flags for non-interactive setup or run without flags to open the wizard.`, Args: cobra.ArbitraryArgs, RunE: runAddSkill, }
View Source
var AgentCmd = &cobra.Command{ Use: "agent", Short: "Commands for managing agents", Long: `Commands for managing agents.`, Args: cobra.ArbitraryArgs, Example: `arctl agent list arctl agent show dice arctl agent publish ./my-agent arctl agent remove dice arctl agent run ./my-agent`, }
View Source
var BuildCmd = &cobra.Command{ Use: "build [project-directory]", Short: "Build Docker images for an agent project", Long: `Build Docker images for an agent project created with the init command. This command looks for agent.yaml in the specified directory, regenerates template artifacts, and invokes docker build (plus optional push) for both the agent and any command-type MCP servers.`, Args: cobra.ExactArgs(1), RunE: runBuild, Example: `arctl agent build ./my-agent`, }
View Source
var DeleteCmd = &cobra.Command{ Use: "delete <agent-name>", Short: "Delete an agent from the registry", Long: `Delete an agent from the registry. The agent must not be published or deployed unless --force is used. Examples: arctl agent delete my-agent --version 1.0.0 arctl agent delete my-agent --version 1.0.0 --force`, Args: cobra.ExactArgs(1), RunE: runDelete, }
View Source
var DeployCmd = &cobra.Command{ Use: "deploy [agent-name]", Short: "Deploy an agent", Long: `Deploy an agent from the registry. Example: arctl agent deploy my-agent --version latest arctl agent deploy my-agent --version 1.2.3 arctl agent deploy my-agent --version latest --runtime kubernetes`, Args: cobra.ExactArgs(1), PreRunE: func(cmd *cobra.Command, args []string) error { runtimeFlag, _ := cmd.Flags().GetString("runtime") if runtimeFlag != "" { if err := runtime.ValidateRuntime(runtimeFlag); err != nil { return err } } return nil }, RunE: runDeploy, }
View Source
var InitCmd = &cobra.Command{ Use: "init [framework] [language] [agent-name]", Short: "Initialize a new agent project", Long: `Initialize a new agent project using the specified framework and language. You can customize the root agent instructions using the --instruction-file flag. You can select a specific model using --model-provider and --model-name flags. If no custom instruction file is provided, a default dice-rolling instruction will be used. If no model is specified, the agent will need to be configured later. Examples: arctl agent init adk python dice arctl agent init adk python dice --instruction-file instructions.md arctl agent init adk python dice --model-provider Gemini --model-name gemini-2.0-flash`, Args: cobra.ExactArgs(3), RunE: runInit, Example: `arctl agent init adk python dice`, }
View Source
var ListCmd = &cobra.Command{
Use: "list",
Short: "List agents",
Long: `List agents that are published to the registry.`,
RunE: runList,
}
View Source
var PublishCmd = &cobra.Command{ Use: "publish [project-directory|agent-name]", Short: "Publish an agent project to the registry", Long: `Publish an agent project to the registry. This command supports two forms: - 'arctl agent publish ./my-agent' publishes the agent defined by agent.yaml in the given folder. - 'arctl agent publish my-agent --version 1.2.3' publishes an agent that already exists in the registry by name and version. Examples: arctl agent publish ./my-agent arctl agent publish my-agent --version latest`, Args: cobra.ExactArgs(1), RunE: runPublish, Example: `arctl agent publish ./my-agent`, }
View Source
var RemoveCmd = &cobra.Command{ Use: "remove [name] [args...]", Short: "Remove an agent", Long: `Remove an agent that is deployed. Use flags for non-interactive setup or run without flags to open the wizard.`, Args: cobra.ArbitraryArgs, RunE: runRemove, }
View Source
var RunCmd = &cobra.Command{ Use: "run [project-directory-or-agent-name]", Short: "Run an agent locally and launch the interactive chat", Long: `Run an agent project locally via docker compose. If the argument is a directory, arctl uses the local files; otherwise it fetches the agent by name from the registry and launches the same chat interface.`, Args: cobra.ExactArgs(1), RunE: runRun, Example: `arctl agent run ./my-agent arctl agent run dice`, }
View Source
var ShowCmd = &cobra.Command{ Use: "show <agent-name>", Short: "Show details of an agent", Long: `Shows detailed information about an agent.`, Args: cobra.ExactArgs(1), RunE: runShow, }
View Source
var UnpublishCmd = &cobra.Command{ Use: "unpublish [agent-name]", Short: "Unpublish an agent from the registry", Long: `Unpublish an agent from the registry by marking it as unpublished. This command operates only on agents that already exist in the registry. It sets the published flag to false, hiding the agent from public listings. Examples: arctl agent unpublish my-agent --version latest arctl agent unpublish my-agent --version 1.2.3`, Args: cobra.ExactArgs(1), RunE: runUnpublish, Example: `arctl agent unpublish my-agent --version latest`, }
Functions ¶
func SetAPIClient ¶
Types ¶
This section is empty.
Source Files
¶
Click to show internal directories.
Click to hide internal directories.