Hexos
Docs
GitHubGitHub
  • Documentation
      • AgentContext
      • AgentDefinition
      • Agent Config
      • ModelConfig
      • RuntimeConfig
      • RuntimeHooks
      • AgentMessage
      • AnthropicModel
      • Attachment
      • DEFAULT_ERROR_MESSAGES
      • ErrorCategory
      • GetUserFriendlyErrorMessage
      • HexosError
      • Core Types
      • LLMProvider
      • MessageRole
      • OllamaModel
      • OpenAIModel
      • RuntimeEvent
    • Common
      • Infrastructure
      • RateLimitConfig
      • RetryConfig
      • Mcp
      • IsMCPSSEConfig
      • IsMCPStdioConfig
      • MCPServerConfig
      • MCPServerConfigBase
      • MCPSSEServerConfig
      • MCPStdioServerConfig
      • MCPToolInfo
      • MCPTransportType
      • Runtime
      • RuntimeInput
      • RuntimeOutput
      • ToolCallResult
      • ApprovalDecision
      • HandoffRecord
      • HandoffResult
      • HandoffToolInput
      • Tools
      • IsHandoffResult
      • ToolApproval
      • ToolCall
      • ToolContext
      • ToolDefinition
      • AgentConfig
      • AgentTransport
      • Transport
      • TransportEvent
      • TransportMessage
      • AssertNever
      • GenerateAllCombinations
      • GetGraphQlInputName
      • Utilities
      • IsClassInstance
      • IsObject
      • NotNullOrUndefined
      • Summate
      • AgentError
      • AgentMessage
      • Attachment
      • Core Types
      • MessagePart
      • ToolCallState
      • ActionDefinition
      • AgentProvider
      • AgentProviderProps
      • ContextDefinition
      • Hooks
      • UseAgent
      • UseAgentAction
      • UseAgentActionReturn
      • UseAgentContext
      • UseAgentReturn
      • UseAgentTool
      • UseFrontendTool
      • UseFrontendTools
      • UseToolApproval
      • UseToolApprovalReturn
    • React Core
      • ActionExecutionState
      • ActiveAgentAtom
      • AddExecutingActionAtom
      • AddHandoffAtom
      • AddMessageAtom
      • AddPendingActionConfirmationAtom
      • AddPendingApprovalAtom
      • AgentConfigAtom
      • AssistantMessagesAtom
      • ClearHandoffsAtom
      • ClearMessagesAtom
      • ConversationIdAtom
      • ErrorAtom
      • ErrorInfoAtom
      • ExecutingActionsAtom
      • FrontendContextAtom
      • FrontendToolsAtom
      • HandoffEvent
      • HandoffHistoryAtom
      • HasPendingApprovalsAtom
      • State Management
      • IsAnyActionExecutingAtom
      • IsStreamingAtom
      • LastHandoffAtom
      • LastMessageAtom
      • MessageCountAtom
      • MessagesAtom
      • PendingActionConfirmation
      • PendingActionConfirmationCountAtom
      • PendingActionConfirmationsAtom
      • PendingApprovalCountAtom
      • PendingToolCallsAtom
      • RemoveContextAtom
      • RemoveExecutingActionAtom
      • RemovePendingActionConfirmationAtom
      • RemovePendingApprovalAtom
      • StreamingMessageAtom
      • TransportAtom
      • UpdateContextAtom
      • UpdateExecutingActionAtom
      • UpdateMessageAtom
      • UserMessagesAtom
      • ApprovalDecision
      • FrontendToolDefinition
      • Tools
      • ToolApprovalRequest
      • AgentConfig
      • AgentTransport
      • Transport
      • SSETransport
      • TransportEvent
      • TransportMessage
    • React Ui
      • ActionConfirmContainer
      • ActionConfirmContainerProps
      • ActionConfirmDialog
      • ActionConfirmDialogProps
      • AgentAvatar
      • AgentAvatarProps
      • AgentBadge
      • AgentBadgeProps
      • AgentDot
      • AgentDotProps
      • AgentInfo
      • AgentStatusBar
      • AgentStatusBarProps
      • AgentSwitcher
      • AgentSwitcherProps
      • AGENT_COLORS
      • ChatWindow
      • ChatWindowProps
      • GetAgentColors
      • HandoffArrow
      • HandoffArrowProps
      • HandoffIndicator
      • HandoffIndicatorProps
      • Ui Components
      • InputComposer
      • InputComposerProps
      • MessageBubble
      • MessageBubbleProps
      • MessageList
      • MessageListProps
      • PaperclipIcon
      • PendingApprovalBadge
      • PendingApprovalBadgeProps
      • QuickReplies
      • QuickRepliesProps
      • ReasoningDisplay
      • ReasoningDisplayProps
      • SendIcon
      • StreamingIndicator
      • StreamingIndicatorProps
      • ToolApprovalContainer
      • ToolApprovalContainerProps
      • ToolApprovalDialog
      • ToolApprovalDialogProps
      • ToolCallRenderProps
      • ToolCallRenderer
      • ToolCallRendererProps
      • Button
      • ButtonProps
      • ButtonVariants
      • Ui Primitives
      • Textarea
      • TextareaProps
      • AgentUIProvider
      • AgentUIProviderProps
      • AgentUITheme
      • DisplayConfig
      • GetDefaultTheme
      • Ui Theme
      • ResolvedDisplayConfig
      • ResolvedToolDisplayOptions
      • ToolDisplayMode
      • ToolDisplayOptions
      • UseAgentUITheme
      • UseDisplayConfig
      • CreateAgentHandler
      • CreateApprovalHandler
      • CreateExpressHandler
      • AgentRuntime
      • AgentState
      • AgentStateType
      • CreateAgentNode
      • CreateAgentRouter
      • CreateApprovalGateNode
      • CreateResponseFormatterNode
      • CreateRouterNode
      • CreateToolExecutorNode
      • Graph
    • Runtime
      • Infrastructure
      • IsRetryableError
      • NormalizeRuntimeConfig
      • NormalizedRateLimitConfig
      • NormalizedRetryConfig
      • NormalizedRuntimeConfig
      • RateLimitResult
      • RetryOptions
      • RetryWithBackoff
      • Semaphore
      • SemaphoreTimeoutError
      • SlidingWindowRateLimiter
      • TimeoutError
      • WithTimeout
      • AnthropicStreamParams
      • ConvertToolsToAnthropicFormat
      • ConvertToolsToOllamaFormat
      • ConvertToolsToOpenAIFormat
      • CreateAnthropicClient
      • CreateOllamaClient
      • CreateOpenAIClient
      • Llm Providers
      • OllamaStreamParams
      • OllamaTool
      • OpenAIStreamParams
      • ProviderApprovalDecision
      • ProviderDependencies
      • ProviderErrorInfo
      • ProviderHooks
      • StreamWithAnthropicProvider
      • StreamWithOllamaProvider
      • StreamWithOpenAIProvider
      • ZodToJsonSchema
      • DEFAULT_RETRY
      • IMCPClient
      • Mcp
      • MCPClient
      • MCPManager
      • MCPManagerOptions
      • MCPSSEClient
      • MCPToolWithServer
      • SanitizeToolName
      • GenerateHandoffTools
      • GetHandoffTargetFromToolName
      • HandoffInputSchema
      • Tools
      • IsHandoffTool
      • ErrorCategory
      • Utils
      • SanitizeError
      • SanitizedError
      • Commands
        • Install
        • InstallCommand
        • InstallCommandOptions
      • RegisterHexosCommands
        • Upgrade
        • UpgradeCommand
        • UpgradeCommandOptions
      • AssertNextAppRouterProject
      • AssertNodeVersion
      • BuildFileActionPlan
      • BuildManagedMetadata
      • ConflictResolution
      • DetectPackageManager
      • FileActionPlanItem
      • GenerateInstallFiles
      • GetDefaultHexosVersion
      • GetManifestPath
      • GetSkippedConflictPaths
      • GetWritablePlans
      • HashContent
      • HashFile
      • Core
      • InstallDependencies
      • MergeEnvContent
      • ProjectInfo
      • ReadManifest
      • ResolveConflicts
      • ResolveProjectInfo
      • WriteManifest
    • Cli
      • Error
      • FormatPath
      • Shared
      • Info
      • Success
      • Warn

On This Page

  • projectPath
  • options
Question? Give us feedback →Edit this page
DocsclicommandsinstallInstallCommand
Package: @hexos/cli
function installCommand(projectPath: string | undefined, options: InstallCommandOptions): void

Parameters

projectPath

string | undefined

options

InstallCommandOptions
InstallInstallCommandOptions

MIT © 2026 The Contributors