> ## Documentation Index > Fetch the complete documentation index at: https://docs.julep.ai/llms.txt > Use this file to discover all available pages before exploring further. # Command Reference > Commands for managing Julep projects and resources ## Overview It is still in experimental phase and is not yet complete. In case of any issues, please reach out to us on [Discord](https://discord.com/invite/JTSBGRZrzj) or [email](mailto:hey@julep.ai). The `julep` CLI is a comprehensive command-line interface for interacting with the Julep platform. Following are the available commands. ## Authentication ```bash theme={"dark"} julep auth ``` The `julep auth` command is used to authenticate your Julep CLI. This will prompt you to enter your API key and save it to the configuration file. **Example:** ```bash theme={"dark"} # Basic authentication with interactive prompt julep auth # Output: # Enter your Julep API key: ********************** # Authentication successful! ``` ```bash theme={"dark"} julep auth --api-key your_julep_api_key ``` The `julep auth --api-key your_julep_api_key` command is used to authenticate your Julep CLI with a specific API key. Your Julep API key **Examples:** ```bash theme={"dark"} # Authenticate with API key directly julep auth --api-key "julep_1234567890abcdef" # Using environment variable export JULEP_API_KEY="julep_1234567890abcdef" julep auth --api-key $JULEP_API_KEY ``` ```bash theme={"dark"} julep auth --api-key your_key --environment staging ``` The `julep auth --api-key your_key --environment staging` command is used to authenticate your Julep CLI with a specific API key and environment. Your Julep API key Environment to use (production/staging) **Examples:** ```bash theme={"dark"} # Authenticate with staging environment julep auth --api-key "julep_1234567890abcdef" --environment staging # Authenticate with production environment julep auth --api-key "julep_1234567890abcdef" --environment production # Using environment variables export JULEP_API_KEY="julep_1234567890abcdef" export JULEP_ENV="staging" julep auth --api-key $JULEP_API_KEY --environment $JULEP_ENV ``` You can get your API key from the [Julep Dashboard](https://dashboard.julep.ai/). ## Project Management ```bash theme={"dark"} julep init --template "Template Name" --path "Destination Path" --yes ``` The `julep init` command is used to initialize a new Julep project using a predefined template. You can check the list of available templates in our [library](https://github.com/julep-ai/library). Name of the template to use from the library repository (default: "hello-world") Destination directory for where you want to initialize the project (default: current directory) Skip confirmation prompt **Examples:** ```bash theme={"dark"} # Initialize a project with the default template (hello-world template) julep init # Initialize a project with a specific template julep init --template "profiling-recommending" --path "./my-project" # Will be initialized in ./my-project/profiling-recommending # Initialize a project and skip confirmation julep init --yes ``` ```bash theme={"dark"} julep sync [--force-local] [--force-remote] [--source "Source Path"] ``` The `julep sync` command is used to synchronize the local project with the Julep platform. Force local files to take precedence Force remote state to take precedence Watch for changes and synchronize automatically. > **Note:** when watch mode is enabled, only local-to-remote sync `force-local` is supported. Use `--force-remote` only with watch mode turned off. Source directory to sync from (default: current directory) **Examples:** ```bash theme={"dark"} # Basic sync julep sync # Force local changes to override remote julep sync --force-local # Force remote state to override local julep sync --force-remote # Sync with specific source directory julep sync --source ./my-project # Watch for changes and synchronize automatically julep sync --watch ``` ```bash theme={"dark"} julep import --agent --id agent_id --output path ``` The `julep import` command is used to import an `agent`, `task`, or `tool` from the Julep platform. > **Note:** Importing tasks and tools is not yet supported; only agents are supported. Specify that you want to import an agent ID of the agent to import Path to the source directory. Defaults to current working directory Path to save the imported agent (default: `/src/agents/.yaml`) Skip confirmation prompt **Examples:** ```bash theme={"dark"} # Import agent to default directory julep import --agent --id "00000000-0000-0000-0000-000000000000" # Import agent with specific filename julep import --agent --id "00000000-0000-0000-0000-000000000000" --output ./agents/my-agent.yaml # Import agent and skip confirmation julep import --agent --id "00000000-0000-0000-0000-000000000000" --yes ``` ## Task Execution ```bash theme={"dark"} julep run --task --input '{"key": "value"}' ``` The `julep run` command is used to execute a task. ID of the task to execute Input data for the task Path to a json file containing the input to execute the task with Wait for the task to complete before exiting, stream logs to stdout **Examples:** ```bash theme={"dark"} # Run task with inline JSON input julep run --task "00000000-0000-0000-0000-000000000000" --input '{"prompt": "Write a story about a magical forest"}' # Run task with input from file julep run --task "00000000-0000-0000-0000-000000000000" --input-file ./inputs/story-params.json # Run task and wait for completion julep run --task "00000000-0000-0000-0000-000000000000" --input '{"style": "watercolor"}' --wait # Run task that doesn't require input (empty object) julep run --task "00000000-0000-0000-0000-000000000000" --input '{}' # Invalid task ID julep run --task bad-id --input '{}' # -> Error creating execution: Task not found ``` ```bash theme={"dark"} julep logs --execution-id exec_id [--tail] ``` The `julep logs` command is used to view execution logs. ID of the execution to view logs for Continuously stream logs as they are generated **Examples:** ```bash theme={"dark"} # View logs for a specific execution julep logs --execution-id "00000000-0000-0000-0000-000000000000" # Stream logs in real-time julep logs --execution-id "00000000-0000-0000-0000-000000000000" --tail # Get logs in JSON format julep logs --execution-id "00000000-0000-0000-0000-000000000000" --json ``` ## Agent Management The commands in `julep agents` are used to manage your agents. ```bash theme={"dark"} julep agents create --name "Agent Name" \ --model "Model Name" \ --about "Agent Description" \ --metadata '{"key": "value"}' \ --instructions "Instruction" ``` The `julep agents create` command is used to create a new agent. Name of the agent Model to be used (e.g., gpt-4). You can find the list of models [here](/integrations/supported-models#available-models) Description of the agent Additional metadata (JSON format) Instructions for the agent (can be repeated) Path to agent definition file **Examples:** ```bash theme={"dark"} # Create a basic agent julep agents create --name "Story Writer" --model "gpt-4" # Create agent with full configuration julep agents create \ --name "Content Assistant" \ --model "gpt-4" \ --about "AI assistant for content creation" \ --metadata '{"type": "content", "version": "1.0"}' \ --instructions "Focus on creative writing" \ --instructions "Maintain professional tone" # Create agent from definition file julep agents create --definition ./agents/content-assistant.yaml ``` > **Note:** When creating an agent, the agent doesn't get automatically imported to the project. You can run `julep import --agent --id ` to import the agent to the project. ```bash theme={"dark"} julep agents update --id agent_id \ --name "New Name" \ --model "New Model" ``` The `julep agents update` command is used to update an existing agent. ID of the agent to update New name for the agent New model for the agent New description for the agent Additional metadata (JSON format) New instructions for the agent (can be repeated) **Examples:** ```bash [expandable] theme={"dark"} # Update agent name julep agents update --id "agent_abc123" --name "Enhanced Writer" # Update multiple properties julep agents update \ --id "agent_abc123" \ --name "Content Pro" \ --model "gpt-4" \ --about "Professional content creation assistant" # Update metadata julep agents update \ --id "agent_abc123" \ --metadata '{"type": "content", "version": "2.0"}' # Update instructions julep agents update \ --id "agent_abc123" \ --instructions "New instruction 1" \ --instructions "New instruction 2" # Update from definition file julep agents update --id "agent_abc123" --definition ./agents/updated-agent.yaml ``` ```bash theme={"dark"} julep agents delete --id agent_id [--force] ``` The `julep agents delete` command is used to delete an existing agent. ID of the agent to delete Skip confirmation prompt **Examples:** ```bash theme={"dark"} # Delete with confirmation prompt julep agents delete --id "00000000-0000-0000-0000-000000000000" # Force delete without confirmation julep agents delete --id "00000000-0000-0000-0000-000000000000" --force # Delete multiple agents using a bash for loop for id in agent_id1 agent_id2 agent_id3; do julep agents delete --id "$id" --force done ``` ```bash theme={"dark"} julep agents list [--metadata-filter '{"key": "value"}'] [--json] ``` The `julep agents list` command is used to list all agents. Filter agents by metadata Output in JSON format **Examples:** ```bash theme={"dark"} # List all agents julep agents list # List agents with JSON output julep agents list --json # Filter agents by metadata julep agents list --metadata-filter '{"type": "content"}' # List agents and process with jq julep agents list --json | jq '.[] | select(.model=="gpt-4")' # Save agent list to file julep agents list --json > agents.json ``` ```bash theme={"dark"} julep agents get --id agent_id [--json] ``` The `julep agents get` command is used to get details of a specific agent. ID of the agent to retrieve Output in JSON format **Examples:** ```bash theme={"dark"} # Get agent details julep agents get --id "agent_abc123" # Get agent details in JSON format julep agents get --id "agent_abc123" --json # Save agent details to file julep agents get --id "agent_abc123" --json > agent.json # Get and process with jq julep agents get --id "agent_abc123" --json | jq '.instructions' ``` ## Task Management ```bash theme={"dark"} julep tasks create --name "Task Name" \ --agent-id agent_id \ --definition path/to/task.yaml \ --metadata '{"status": "beta"}' \ --inherit-tools ``` The `julep tasks create` command is used to create a new task. ID of the associated agent Name of the task Path to task definition file Additional metadata (JSON format) Inherit tools from agent Import to project after creating ```bash theme={"dark"} julep tasks update --id task_id \ --name "New Name" \ --agent-id new_agent_id \ --definition new/path/to/task.yaml ``` The `julep tasks update` command is used to update an existing task. ID of the task to update New name for the task New agent ID for the task Path to new task definition file New description for the task New metadata for the task Whether to inherit tools from the agent ```bash theme={"dark"} julep tasks delete --id task_id [--force] ``` The `julep tasks delete` command is used to delete an existing task. ID of the task to delete Skip confirmation prompt ```bash theme={"dark"} julep tasks list [--agent-id agent_id] [--json] ``` The `julep tasks list` command is used to list all tasks. Filter by associated agent ID Output in JSON format ```bash theme={"dark"} julep tasks get --id task_id [--json] ``` The `julep tasks get` command is used to get details of a specific task. ID of the task to retrieve Output in JSON format ## Tool Management ```bash theme={"dark"} julep tools create --name "Tool Name" \ --type tool_type \ --agent-id agent_id \ --definition path/to/config.yaml ``` The `julep tools create` command is used to create a new tool. ID of the associated agent Name of the tool Type of the tool Path to tool definition file Description of the tool Additional metadata (JSON format) Import to project after creating ```bash theme={"dark"} julep tools update --id tool_id \ --name "New Name" \ --agent-id new_agent_id \ --definition new/path/to/config.yaml ``` The `julep tools update` command is used to update an existing tool. ID of the tool to update New name for the tool New agent ID for the tool Path to new tool definition file New description for the tool New metadata for the tool ```bash theme={"dark"} julep tools delete --agent-id agent_id --id tool_id [--force] ``` The `julep tools delete` command is used to delete an existing tool. ID of the agent the tool is associated with ID of the tool to delete Skip confirmation prompt ```bash theme={"dark"} julep tools list --agent-id agent_id [--json] ``` The `julep tools list` command is used to list all tools for a given agent. Filter by associated agent ID Output in JSON format A future release will add a `julep tools get` command for retrieving a tool by ID. ## Execution Management ```bash theme={"dark"} julep executions create --task task_id --input '{"key": "value"}' ``` The `julep executions create` command is used to create a new execution for a task. ID or name of the task to execute JSON string representing the input for the task (defaults to {}) Path to a file containing the input for the task ```bash theme={"dark"} julep executions list [--task-id task_id] [--json] ``` The `julep executions list` command is used to list all executions or filter based on criteria. Filter executions by associated task ID Output the list in JSON format ```bash theme={"dark"} julep executions cancel --id execution_id ``` The `julep executions cancel` command is used to cancel an existing execution. ID of the execution to cancel The CLI will soon include a `julep assistant` command that launches an interactive prompt for generating commands from plain language. This feature is still under development. ## Miscellaneous ```bash theme={"dark"} julep --version ``` The `julep --version` or `julep -v` command displays the current version of the Julep CLI. ```bash theme={"dark"} julep --help ``` The `julep --help` or `julep -h` command displays help information for the Julep CLI. ## Best Practices ### File Management * **Project Configuration**: Keep your `julep.yaml` clean and well-organized * **Lock File**: Use `julep-lock.json` to track remote state and relationships * **Source Files**: Organize definitions in appropriate directories under `src/` ### Workflow Tips * Use `julep sync` regularly to keep local and remote states in sync * Review changes with `--json` output before applying updates * Use the assistant mode for complex workflows: `julep assistant` ### Security Best Practices * Store API keys securely * Use environment-specific configurations * Review permissions before executing destructive commands * Use `--force` flags cautiously Always review the changes before using force flags (`--force-local`, `--force-remote`) as they can override remote or local state. ## Support If you need help with further questions in Julep: * Join our [Discord community](https://discord.com/invite/JTSBGRZrzj) * Check the [GitHub repository](https://github.com/julep-ai/julep) * Contact support at [hey@julep.ai](mailto:hey@julep.ai)