@inkeep/agents-cli 0.0.0-chat-to-edit-20251119071712

package/LICENSE.md

@@ -0,0 +1,56 @@
+<!--
+AUTO-GENERATED FILE - DO NOT EDIT DIRECTLY
+Source: ./LICENSE.md
+This file is automatically copied from the root LICENSE.md during build.
+Any changes should be made to the root LICENSE.md file.
+-->
+
+# Inkeep SDK – Elastic License 2.0 with Supplemental Terms
+
+NOTE: The Inkeep SDK is licensed under the Elastic License 2.0 (ELv2), subject to Supplemental Terms included in [SUPPLEMENTAL_TERMS.md](SUPPLEMENTAL_TERMS.md). In the event of conflict, the Supplemental Terms control.
+
+# Elastic License 2.0
+
+## Acceptance  
+By using the software, you agree to all of the terms and conditions below.
+
+## Copyright License
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below.
+
+## Limitations
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+## Patents
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Notices
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+## No Other Rights
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+## Termination
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+## No Liability
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+The **licensor** is the entity offering these terms, and the **software** is the software the licensor makes available under these terms, including any portion of it.
+
+**you** refers to the individual or entity agreeing to these terms.
+
+**your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. **control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+**your licenses** are all the licenses granted to you for the software under these terms.
+
+**use** means anything you do with the software requiring one of your licenses.
+
+**trademark** means trademarks, service marks, and similar rights.
+

package/README.md

@@ -0,0 +1,631 @@
+# Inkeep CLI
+
+A command-line interface for managing and interacting with Inkeep Agent Frameworks.
+
+## Installation & Setup
+
+### Prerequisites
+
+- Node.js >= 20.x
+- pnpm package manager
+- Inkeep Agent Framework backend running (default: http://localhost:3002)
+- `@inkeep/agents-manage-ui` package installed (for visual agents orchestration)
+
+### Quick Start
+
+> **📖 For detailed setup instructions, see [SETUP.md](./SETUP.md)**
+
+1. **Install and build**
+
+   ```bash
+   # Navigate to the CLI directory
+   cd /path/to/agent-framework/agents-cli
+
+   # Install dependencies
+   pnpm install
+
+   # Build the CLI
+   pnpm build
+   ```
+
+2. **Install globally** (recommended)
+
+   **Option A: Using npm link (for development)**
+
+   ```bash
+   # Create global symlink from the agents-cli directory
+   npm link
+
+   # Verify installation
+   which inkeep  # Should show path to inkeep command
+   ```
+
+   **Option B: Using pnpm/npm global install (after publishing)**
+
+   ```bash
+   # Install the scoped package globally
+   pnpm add -g @inkeep/agents-cli
+   # or
+   npm install -g @inkeep/agents-cli
+
+   # Verify installation
+   inkeep --version
+   ```
+
+   **Note:**
+
+   - For local development, use `npm link` (more reliable than `pnpm link --global`)
+   - The command is still `inkeep` even though the package name is `@inkeep/agents-cli`
+   - If linking fails, try unlinking first: `npm unlink -g @inkeep/agents-cli`
+
+3. **Install the dashboard package (for visual agents orchestration)**
+
+```bash
+# Install the dashboard UI package for visual agents orchestration
+npm install @inkeep/agents-manage-ui
+# or
+pnpm add @inkeep/agents-manage-ui
+```
+
+4. **Configure your project**
+
+```bash
+# Create an inkeep.config.ts file with your tenant ID
+inkeep init
+
+# Or manually create inkeep.config.ts:
+# export default defineConfig({
+#   tenantId: "your-tenant-id",
+#   projectId: "your-project-id",
+#   agentsManageApiUrl: "http://localhost:3002",
+#   agentsRunApiUrl: "http://localhost:3003"
+# });
+```
+
+## Configuration
+
+### Configuration Sources (priority order)
+
+1. **Command-line flags** - Highest priority (e.g., `--tenant-id`, `--agents-manage-api-url`, `--config`)
+2. **Config file** - `inkeep.config.ts` (or file specified with `--config`)
+3. **Environment variables** - `INKEEP_AGENTS_MANAGE_API_URL`, `INKEEP_AGENTS_RUN_API_URL`
+4. **Defaults** - Lowest priority (defaults to `http://localhost:3002` and `http://localhost:3003`)
+
+### Config File Options
+
+Most commands support the `--config` option to specify a custom configuration file:
+
+```bash
+# Use custom config file
+inkeep list-graphs --project my-project --config ./staging-config.ts
+
+# Backward compatibility (deprecated)
+inkeep list-graphs --project my-project --config-file-path ./staging-config.ts
+```
+
+### Environment Variables
+
+Create a `.env` file in your project directory:
+
+```bash
+INKEEP_AGENTS_MANAGE_API_URL=http://localhost:3002
+INKEEP_AGENTS_RUN_API_URL=http://localhost:3003
+```
+
+Or export them in your shell:
+
+```bash
+export INKEEP_AGENTS_MANAGE_API_URL=http://localhost:3002
+export INKEEP_AGENTS_RUN_API_URL=http://localhost:3003
+```
+
+## Commands
+
+### `inkeep add [template]`
+
+Pull a template project from the [Inkeep Agents Cookbook](https://github.com/inkeep/agents/tree/main/agents-cookbook/template-projects).
+
+```bash
+# Add a template
+inkeep add my-template
+
+# Add template to specific path
+inkeep add my-template --target-path ./src/templates
+
+# Using config file
+inkeep add my-template --config ./my-config.ts
+```
+
+### `inkeep init [path]`
+
+Initialize a new Inkeep configuration file.
+
+```bash
+# Interactive initialization
+inkeep init
+
+# Initialize in specific directory
+inkeep init ./my-project
+
+# Skip interactive prompts
+inkeep init --no-interactive
+
+# Use existing config as template
+inkeep init --config ./template-config.ts
+```
+
+### `inkeep config`
+
+Manage Inkeep configuration values.
+
+```bash
+# Get configuration value
+inkeep config get tenantId
+
+# Set configuration value
+inkeep config set tenantId my-tenant-id
+
+# List all configuration values
+inkeep config list
+
+# Using specific config file
+inkeep config get tenantId --config ./my-config.ts
+```
+
+### `inkeep pull`
+
+Pull entire project configuration from backend and update local files.
+
+```bash
+# Pull current project
+inkeep pull
+
+# Pull specific project
+inkeep pull --project my-project-id
+
+# Generate environment file
+inkeep pull --env production
+
+# Generate JSON file instead of updating files
+inkeep pull --json
+
+# Enable debug logging
+inkeep pull --debug
+
+# Using config file
+inkeep pull --project my-project-id --config ./my-config.ts
+```
+
+### `inkeep dev`
+
+Start the Inkeep dashboard server, build for production, or export the Next.js project.
+
+```bash
+# Start development server
+inkeep dev
+
+# Start on custom port and host
+inkeep dev --port 3001 --host 0.0.0.0
+
+# Build for production (packages standalone build)
+inkeep dev --build --output-dir ./build
+
+# Export Next.js project source files
+inkeep dev --export --output-dir ./my-dashboard
+
+# Get dashboard path for deployment
+DASHBOARD_PATH=$(inkeep dev --path)
+echo "Dashboard built at: $DASHBOARD_PATH"
+
+# Use with Vercel
+vercel --cwd $(inkeep dev --path) -Q .vercel build
+
+# Use with Docker
+docker build -t inkeep-dashboard $(inkeep dev --path)
+
+# Use with other deployment tools
+rsync -av $(inkeep dev --path)/ user@server:/var/www/dashboard/
+```
+
+### `inkeep tenant [tenant-id]` ⚠️ NOT IMPLEMENTED
+
+> **⚠️ WARNING: This command is not yet implemented in the current CLI.**
+> Use `inkeep.config.ts` to set your tenant ID instead.
+
+Manage tenant configuration.
+
+```bash
+# Set tenant ID
+inkeep tenant my-tenant
+
+# View current tenant ID
+inkeep tenant
+```
+
+### `inkeep list-graphs`
+
+List all available graphs for a specific project.
+
+```bash
+# List graphs for a project (required)
+inkeep list-graphs --project my-project-id
+
+# With custom API URL
+inkeep list-graphs --project my-project-id --agents-manage-api-url http://api.example.com:3002
+
+# With custom tenant ID
+inkeep list-graphs --project my-project-id --tenant-id my-tenant-id
+
+# Using config file
+inkeep list-agents --project my-project-id --config ./my-config.ts
+```
+
+Output:
+
+```
+┌─────────────────────────┬────────────────────┬───────────────┬───────────┐
+│ Agent ID                │ Name               │ Default Agent │ Created   │
+├─────────────────────────┼────────────────────┼───────────────┼───────────┤
+│ customer-support-graph  │ Customer Support   │ router        │ 1/15/2025 │
+│ qa-assistant           │ QA Assistant       │ qa-agent      │ 1/14/2025 │
+└─────────────────────────┴────────────────────┴───────────────┴───────────┘
+```
+
+### `inkeep push`
+
+Push your project configuration to the backend.
+
+```bash
+# Push the current project (from the directory with inkeep.config.ts)
+inkeep push
+
+# Push specific project
+inkeep push --project my-project-id
+
+# With custom configuration
+inkeep push --project my-project-id --config ./my-config.ts
+
+# With custom API URLs
+inkeep push --project my-project-id --agents-manage-api-url http://manage.example.com --agents-run-api-url http://run.example.com
+
+# With custom tenant ID
+inkeep push --project my-project-id --tenant-id my-tenant-id
+```
+
+**Features:**
+
+- Automatically injects tenant ID and API URL from `inkeep.config.ts`
+- Validates exactly one Agent is exported
+- Warns about dangling resources (unreferenced agents/tools)
+- Shows graph summary after successful push
+- Handles graph initialization automatically
+
+**Agent files:** Define your agents in your project (e.g., `agents/*.ts`). The CLI pushes the project containing those agents.
+
+**Example graph configuration:**
+
+```javascript
+// customer-support.agent.ts
+import { agent, subAgent, tool } from "@inkeep/agents-sdk";
+
+const assistantSubAgent = subAgent({
+  id: "assistant",
+  name: "Assistant",
+  prompt: "Help users with their questions",
+  canUse: () => [searchTool],
+  // No tenantId needed - injected by CLI
+});
+
+// Must export exactly one agent
+export const myAgent = agent({
+  id: "my-assistant",
+  name: "My Assistant",
+  defaultSubAgent: assistantSubAgent,
+  subAgents: () => [assistantSubAgent],
+  // No tenantId or apiUrl needed - CLI injects from config
+});
+// No agent.init() call - CLI handles initialization
+```
+
+### `inkeep mcp start <graph-file>` ⚠️ NOT IMPLEMENTED
+
+> **⚠️ WARNING: This command is not yet implemented in the current CLI.**
+> MCP functionality is planned but not available in the current version.
+
+Start MCP (Model Context Protocol) servers defined in a graph file.
+
+```bash
+# Start MCP servers from a TypeScript agent file
+inkeep mcp start examples/agent-configurations/weather-agent.ts
+
+# Start from compiled JavaScript
+inkeep mcp start dist/examples/agent-configurations/weather-agent.js
+
+# Run in detached mode
+inkeep mcp start my-agent.ts --detached
+
+# Show verbose output
+inkeep mcp start my-agent.ts --verbose
+```
+
+**Features:**
+
+- Supports both TypeScript (`.ts`) and JavaScript (`.js`) files
+- Automatically allocates ports for local servers (3100-3200)
+- Shows server names, ports, and URLs
+- Distinguishes between local (🏠) and remote (☁️) servers
+
+### `inkeep mcp stop` ⚠️ NOT IMPLEMENTED
+
+> **⚠️ WARNING: This command is not yet implemented in the current CLI.**
+
+Stop running MCP servers.
+
+```bash
+# Stop all servers
+inkeep mcp stop --all
+
+# Stop servers for a specific graph
+inkeep mcp stop --graph customer-support-graph
+```
+
+### `inkeep mcp status` ⚠️ NOT IMPLEMENTED
+
+> **⚠️ WARNING: This command is not yet implemented in the current CLI.**
+
+Show status of all MCP servers.
+
+```bash
+inkeep mcp status
+```
+
+Output shows:
+
+- Process ID
+- Graph ID
+- Tool name
+- Port/URL
+- Running status
+- Uptime
+
+### `inkeep mcp list` ⚠️ NOT IMPLEMENTED
+
+> **⚠️ WARNING: This command is not yet implemented in the current CLI.**
+
+List all MCP servers with detailed information.
+
+```bash
+# Default tree view
+inkeep mcp list
+
+# Table format
+inkeep mcp list --format table
+
+# Verbose output (includes descriptions)
+inkeep mcp list --verbose
+```
+
+## Complete Workflow Example
+
+### Basic Setup
+
+```bash
+# Install and link CLI
+cd agents-cli
+pnpm install
+pnpm build
+npm link
+
+# Initialize configuration
+inkeep init
+# Edit inkeep.config.ts to set your tenantId and projectId
+```
+
+### Working with Graphs and MCP Servers ⚠️ NOT AVAILABLE
+
+> **⚠️ WARNING: MCP commands shown below are not yet implemented.**
+> This section shows planned functionality that is not available in the current version.
+
+1. **Create an agent with MCP tools** (`my-agent.ts`)
+
+```typescript
+import {
+  agent,
+  subAgent,
+  mcpServer,
+} from "@inkeep/agents-sdk";
+
+// Define MCP servers (tools)
+const randomNumberServer = mcpServer({
+  name: "random_number",
+  description: "Generates a random number",
+  execute: async () => Math.random(),
+});
+
+const weatherServer = mcpServer({
+  name: "weather_api",
+  description: "Get weather information",
+  serverUrl: "https://api.weather.example.com/mcp",
+});
+
+// Define sub-agents
+const assistantSubAgent = subAgent({
+  id: "assistant",
+  name: "Assistant",
+  prompt: "Help users with various tasks",
+  canUse: () => [randomNumberServer, weatherServer],
+});
+
+// Export the agent
+export const myAgent = agent({
+  id: "my-assistant",
+  name: "My Assistant",
+  defaultSubAgent: assistantSubAgent,
+  subAgents: () => [assistantSubAgent],
+});
+
+// Export servers for MCP management
+export const servers = [randomNumberServer, weatherServer];
+```
+
+2. **Monitor and manage servers**
+
+```bash
+# Check server status
+inkeep mcp status
+
+# List all servers with details
+inkeep mcp list
+
+# Stop servers when done
+inkeep mcp stop --all
+```
+
+## Working with Different Environments
+
+### Development
+
+```bash
+# Using environment variables
+INKEEP_AGENTS_MANAGE_API_URL=http://localhost:3002 inkeep list-graphs
+
+# Using .env file
+echo "INKEEP_AGENTS_MANAGE_API_URL=http://localhost:3002" > .env
+echo "INKEEP_AGENTS_RUN_API_URL=http://localhost:3003" >> .env
+```
+
+### Staging
+
+```bash
+# Set in config file
+# Edit your inkeep.config.ts:
+# agentsManageApiUrl: 'https://staging-manage-api.example.com'
+# agentsRunApiUrl: 'https://staging-run-api.example.com'
+```
+
+### Production
+
+```bash
+# Using environment variables
+export INKEEP_AGENTS_MANAGE_API_URL=https://manage-api.example.com
+export INKEEP_AGENTS_RUN_API_URL=https://run-api.example.com
+inkeep list-graphs
+```
+
+## Development
+
+### Running from Source
+
+```bash
+# Without building (using tsx)
+pnpm tsx src/index.ts <command>
+
+# After building
+node dist/index.js <command>
+
+# Watch mode (auto-rebuild on changes)
+pnpm dev
+```
+
+### Testing
+
+```bash
+# Run tests
+pnpm test
+
+# Watch mode
+pnpm test:watch
+
+# Coverage report
+pnpm test:coverage
+```
+
+### Type Checking
+
+```bash
+pnpm typecheck
+```
+
+### Project Structure
+
+```
+agents-cli/
+├── src/
+│   ├── index.ts              # Main CLI entry point
+│   ├── config.ts             # Configuration management
+│   ├── api.ts                # API client for backend
+│   ├── commands/             # Command implementations
+│   │   ├── push.ts           # Push graph configurations
+│   │   ├── tenant.ts         # Tenant management
+│   │   └── list-graphs.ts    # List graphs
+│   ├── types/                # TypeScript declarations
+│   └── __tests__/            # Test files
+├── dist/                     # Compiled JavaScript
+├── package.json
+├── tsconfig.json
+└── README.md
+```
+
+## Troubleshooting
+
+### Common Issues
+
+**"Failed to fetch graphs" or connection errors**
+
+```bash
+# Check if backend is running
+curl http://localhost:3002/health
+
+# Verify API URLs
+echo $INKEEP_AGENTS_MANAGE_API_URL
+echo $INKEEP_AGENTS_RUN_API_URL
+
+# Try with explicit URL and project
+inkeep list-graphs --project my-project-id --agents-manage-api-url http://localhost:3002
+```
+
+**Command not found: inkeep**
+
+```bash
+# Ensure CLI is linked globally
+cd agents-cli
+npm link
+
+# Or if published, install globally
+pnpm add -g @inkeep/agents-cli
+# or
+npm install -g @inkeep/agents-cli
+
+# Or add to PATH manually (for development)
+export PATH="$PATH:/path/to/agents-cli/dist"
+```
+
+## Dependencies
+
+### Runtime Dependencies
+
+- **commander**: Command-line framework
+- **chalk**: Terminal styling
+- **dotenv**: Environment variable loading
+- **ora**: Loading spinners
+- **cli-table3**: Table formatting
+- **inquirer**: Interactive prompts
+- **inquirer-autocomplete-prompt**: Searchable selections
+
+### Development Dependencies
+
+- **typescript**: TypeScript compiler
+- **@types/node**: Node.js types
+- **vitest**: Testing framework
+- **@vitest/coverage-v8**: Coverage reporting
+
+## Requirements
+
+- Node.js >= 20.x
+- pnpm package manager
+- TypeScript 5.x
+- Inkeep Agent Framework backend
+
+## License
+
+MIT