@inkeep/agents-cli 0.5.0 → 0.6.4

package/README.md

@@ -15,49 +15,54 @@ A command-line interface for managing and interacting with Inkeep Agent Framewor
 > **📖 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:** 
+
+   **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. **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",
@@ -71,11 +76,23 @@ A command-line interface for managing and interacting with Inkeep Agent Framewor
 
 ### Configuration Sources (priority order)
 
-1. **Command-line flags** - Highest priority (e.g., `--tenant-id`, `--api-url`)
-2. **Config file** - `inkeep.config.ts` (required for most commands)
+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:
@@ -94,6 +111,109 @@ 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-cookbook/tree/main/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 or build for production.
+
+```bash
+# Start development server
+inkeep dev
+
+# Start on custom port and host
+inkeep dev --port 3001 --host 0.0.0.0
+
+# Build for production
+inkeep dev --build --output-dir ./build
+
+# 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.**
@@ -111,16 +231,24 @@ inkeep tenant
 
 ### `inkeep list-graphs`
 
-List all available graphs for the current tenant.
+List all available graphs for a specific project.
 
 ```bash
-inkeep list-graphs
+# List graphs for a project (required)
+inkeep list-graphs --project my-project-id
 
 # With custom API URL
-inkeep list-graphs --api-url http://api.example.com:3002
+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-graphs --project my-project-id --config ./my-config.ts
 ```
 
 Output:
+
 ```
 ┌─────────────────────────┬────────────────────┬───────────────┬───────────┐
 │ Graph ID                │ Name               │ Default Agent │ Created   │
@@ -137,9 +265,22 @@ 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 AgentGraph is exported
 - Warns about dangling resources (unreferenced agents/tools)
@@ -152,27 +293,27 @@ inkeep push
 
 ```javascript
 // customer-support.graph.ts
-import { agent, agentGraph, tool } from '@inkeep/agents-manage-api/builder';
+import { agent, agentGraph, tool } from "@inkeep/agents-manage-api/builder";
 
 const assistantAgent = agent({
-    id: 'assistant',
-    name: 'Assistant',
-    instructions: 'Help users with their questions',
-    tools: {
-        search: searchTool
-    }
-    // No tenantId needed - injected by CLI
+  id: "assistant",
+  name: "Assistant",
+  instructions: "Help users with their questions",
+  tools: {
+    search: searchTool,
+  },
+  // No tenantId needed - injected by CLI
 });
 
 // Must export exactly one graph
 export const graph = agentGraph({
-    id: 'my-assistant',
-    name: 'My Assistant Graph',
-    defaultAgent: assistantAgent,
-    agents: {
-        assistant: assistantAgent
-    }
-    // No tenantId or apiUrl needed - CLI injects from config
+  id: "my-assistant",
+  name: "My Assistant Graph",
+  defaultAgent: assistantAgent,
+  agents: {
+    assistant: assistantAgent,
+  },
+  // No tenantId or apiUrl needed - CLI injects from config
 });
 // No graph.init() call - CLI handles initialization
 ```
@@ -188,11 +329,18 @@ inkeep chat my-graph-id
 # Interactive graph selection (with search)
 inkeep chat
 
-# With custom API URL
-inkeep chat --api-url http://api.example.com:3003
+# With custom API URLs
+inkeep chat --agents-manage-api-url http://manage.example.com --agents-run-api-url http://run.example.com
+
+# With custom tenant ID
+inkeep chat --tenant-id my-tenant-id
+
+# Using config file
+inkeep chat --config ./my-config.ts
 ```
 
 **Interactive Features:**
+
 - **Graph selection**: If no graph ID provided, shows searchable list
 - **Chat commands**:
   - `help` - Show available commands
@@ -223,6 +371,7 @@ inkeep mcp start graph.graph.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
@@ -253,6 +402,7 @@ inkeep mcp status
 ```
 
 Output shows:
+
 - Process ID
 - Graph ID
 - Tool name
@@ -277,11 +427,10 @@ inkeep mcp list --format table
 inkeep mcp list --verbose
 ```
 
-
-
 ## Complete Workflow Example
 
 ### Basic Setup
+
 ```bash
 # Install and link CLI
 cd agents-cli
@@ -300,39 +449,44 @@ inkeep init
 > This section shows planned functionality that is not available in the current version.
 
 1. **Create a graph with MCP tools** (`my-graph.graph.ts`)
+
 ```typescript
-import { agent, agentGraph, mcpServer } from '@inkeep/agents-manage-api/builder';
+import {
+  agent,
+  agentGraph,
+  mcpServer,
+} from "@inkeep/agents-manage-api/builder";
 
 // Define MCP servers (tools)
 const randomNumberServer = mcpServer({
-    name: 'random_number',
-    description: 'Generates a random number',
-    execute: async () => Math.random()
+  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'
+  name: "weather_api",
+  description: "Get weather information",
+  serverUrl: "https://api.weather.example.com/mcp",
 });
 
 // Define agents
 const assistantAgent = agent({
-    id: 'assistant',
-    name: 'Assistant',
-    instructions: 'Help users with various tasks',
-    tools: {
-        random: randomNumberServer,
-        weather: weatherServer
-    }
+  id: "assistant",
+  name: "Assistant",
+  instructions: "Help users with various tasks",
+  tools: {
+    random: randomNumberServer,
+    weather: weatherServer,
+  },
 });
 
 // Export the graph
 export const graph = agentGraph({
-    id: 'my-assistant',
-    name: 'My Assistant',
-    defaultAgent: assistantAgent,
-    agents: { assistant: assistantAgent }
+  id: "my-assistant",
+  name: "My Assistant",
+  defaultAgent: assistantAgent,
+  agents: { assistant: assistantAgent },
 });
 
 // Export servers for MCP management
@@ -340,6 +494,7 @@ export const servers = [randomNumberServer, weatherServer];
 ```
 
 2. **Start MCP servers and chat**
+
 ```bash
 # Start MCP servers (works with TypeScript directly!)
 inkeep mcp start my-graph.graph.ts
@@ -353,6 +508,7 @@ inkeep chat my-assistant
 ```
 
 3. **Monitor and manage servers**
+
 ```bash
 # Check server status
 inkeep mcp status
@@ -367,6 +523,7 @@ inkeep mcp stop --all
 ## Working with Different Environments
 
 ### Development
+
 ```bash
 # Using environment variables
 INKEEP_AGENTS_MANAGE_API_URL=http://localhost:3002 inkeep list-graphs
@@ -378,6 +535,7 @@ inkeep chat my-graph
 ```
 
 ### Staging
+
 ```bash
 # Set in config file
 # Edit your inkeep.config.ts:
@@ -386,6 +544,7 @@ inkeep chat my-graph
 ```
 
 ### Production
+
 ```bash
 # Using environment variables
 export INKEEP_AGENTS_MANAGE_API_URL=https://manage-api.example.com
@@ -454,6 +613,7 @@ agents-cli/
 ### Common Issues
 
 **"Failed to fetch graphs" or connection errors**
+
 ```bash
 # Check if backend is running
 curl http://localhost:3002/health
@@ -462,15 +622,15 @@ curl http://localhost:3002/health
 echo $INKEEP_AGENTS_MANAGE_API_URL
 echo $INKEEP_AGENTS_RUN_API_URL
 
-# Try with explicit URL
-inkeep list-graphs --api-url http://localhost:3002
+# Try with explicit URL and project
+inkeep list-graphs --project my-project-id --agents-manage-api-url http://localhost:3002
 ```
 
-
 **"Graph not found" when using chat**
+
 ```bash
-# List available graphs first
-inkeep list-graphs
+# List available graphs first (requires project)
+inkeep list-graphs --project my-project-id
 
 # Use interactive selection
 inkeep chat
@@ -478,6 +638,7 @@ inkeep chat
 ```
 
 **Command not found: inkeep**
+
 ```bash
 # Ensure CLI is linked globally
 cd agents-cli
@@ -495,6 +656,7 @@ export PATH="$PATH:/path/to/agents-cli/dist"
 ## Dependencies
 
 ### Runtime Dependencies
+
 - **commander**: Command-line framework
 - **chalk**: Terminal styling
 - **dotenv**: Environment variable loading
@@ -504,6 +666,7 @@ export PATH="$PATH:/path/to/agents-cli/dist"
 - **inquirer-autocomplete-prompt**: Searchable selections
 
 ### Development Dependencies
+
 - **typescript**: TypeScript compiler
 - **@types/node**: Node.js types
 - **vitest**: Testing framework
@@ -518,4 +681,4 @@ export PATH="$PATH:/path/to/agents-cli/dist"
 
 ## License
 
-MIT
+MIT

package/dist/commands/create.d.ts

@@ -0,0 +1,12 @@
+declare const createAgents: (args?: {
+    tenantId?: string;
+    projectId?: string;
+    dirName?: string;
+    openAiKey?: string;
+    anthropicKey?: string;
+    manageApiPort?: string;
+    runApiPort?: string;
+}) => Promise<void>;
+declare function createCommand(dirName?: string, options?: any): Promise<void>;
+
+export { createAgents, createCommand };