Getting started with Julep CLI
julep
CLI provides a comprehensive command-line interface for interacting with the Julep platform. It enables you to manage agents, tasks, tools, and projects directly from your terminal.
julep-cli
, the installed command is simply julep
.
~/.config/julep/config.yml
. This file is created automatically after authenticating using julep auth
(see Authentication section).
julep.yaml
file defines your project configuration:
julep-lock.json
file tracks the state of your project on the Julep platform, mapping local files to their remote counterparts and maintaining relationships between components. This file should be committed to version control to ensure consistent state across team members.
To know more about the schema and the usage of the julep-lock.json
file, you can read the Lockfile section.
Authenticate
auth
command is used to authenticate with the Julep platform. You need to provide your API key. You can find your API key here.Initialize Project
init
command is used to initialize a new Julep project. There are bunch of templates to get you started which you can find here.Sync Project
sync
command is used to synchronize the local project with the Julep platform. This creates a julep-lock.json
file which tracks the state of the project on the Julep platform (see Sync Command for more details).Edit the project
julep.yaml
file. Add agents, tasks, tools, etc. in the src
directory.Re-Sync Project
julep-lock.json
file with the latest state of the project on the Julep platform.
You can use the --watch
flag to watch the project for changes and re-sync automatically.Run the project
run
command is used to run a task. You can find the task ID in the julep-lock.json
file.View the execution
logs
command is used to view the logs of an execution. When you run the run
command, it will return the execution ID.