Compote CLI
The compote is a command-line tool for the IDF Component Manager. It works with ESP component registry, ESP-IDF projects and components without requiring ESP-IDF installation.
compote
compote [OPTIONS] COMMAND [ARGS]...
Options
- -W, --warnings-as-errors
Treat warnings as errors.
autocomplete
Generate tab-completion scripts for the specified shell.
For ALL users, you may have to log out and log in again to your shell session for the changes to take effect.
compote autocomplete [OPTIONS]
Options
- --shell <shell>
Required Shell type
- Options
bash | zsh | fish
- --install
Create the completion files and inject the sourcing script into your rc files if this flag is set.
- --dry-run
Only useful when flag “–install” is set. Instead of real file system changes, log would be printed if this flag is set.
cache
Group of commands to manage cache of the IDF Component Manager.
compote cache [OPTIONS] COMMAND [ARGS]...
clear
Clear the cache of components and API client cache.
compote cache clear [OPTIONS]
path
Print the cache path.
compote cache path [OPTIONS]
size
Print the cache size in human readable format.
compote cache size [OPTIONS]
Options
- --bytes
Print size in bytes
component
Group of commands to interact with components.
compote component [OPTIONS] COMMAND [ARGS]...
delete
Delete specified version of the component from the component registry. The deleted version cannot be restored or re-uploaded.
compote component delete [OPTIONS]
Options
- --project-dir <manager>
- --service-profile <service_profile>
Profile for component registry to use.
- --namespace <namespace>
Namespace for the component. Can be set in config file.
- --name <name>
Required Component name
- --version <version>
Required Component version to delete.
Environment variables
- IDF_COMPONENT_SERVICE_PROFILE
Provide a default for
--service-profile
- IDF_COMPONENT_NAMESPACE
Provide a default for
--namespace
pack
Create component archive and store it in the dist directory.
compote component pack [OPTIONS]
Options
- --project-dir <manager>
- --namespace <namespace>
Namespace for the component. Can be set in config file.
- --name <name>
Required Component name
- --version <version>
Set version if not defined in the manifest. Use “git” to get version from the git tag. (command would fail if running not from a git tag)
- --dest-dir <dest_dir>
Destination directory for the component archive.
- --repository <repository>
The URL of the component repository. This option overwrites the value in the idf_component.yml
- --commit-sha <commit_sha>
Git commit SHA of the the component version. This option overwrites the value in the idf_component.yml
- --repository-path <repository_path>
Path to the component in the repository. This option overwrites the value in the idf_component.yml
Environment variables
- IDF_COMPONENT_NAMESPACE
Provide a default for
--namespace
upload
Upload component to the component registry.
If the component doesn’t exist in the registry it will be created automatically.
compote component upload [OPTIONS]
Options
- --project-dir <manager>
- --service-profile <service_profile>
Profile for component registry to use.
- --namespace <namespace>
Namespace for the component. Can be set in config file.
- --name <name>
Required Component name
- --version <version>
Set version if not defined in the manifest. Use “git” to get version from the git tag. (command would fail if running not from a git tag)
- --dest-dir <dest_dir>
Destination directory for the component archive.
- --repository <repository>
The URL of the component repository. This option overwrites the value in the idf_component.yml
- --commit-sha <commit_sha>
Git commit SHA of the the component version. This option overwrites the value in the idf_component.yml
- --repository-path <repository_path>
Path to the component in the repository. This option overwrites the value in the idf_component.yml
- --archive <archive>
Path of the archive with a component to upload. When not provided the component will be packed automatically.
- --skip-pre-release
Do not upload pre-release versions.
- --check-only
Check if given component version is already uploaded and exit.
- --allow-existing
Return success if existing version is already uploaded.
- --dry-run
Upload component for validation without creating a version in the registry.
Environment variables
- IDF_COMPONENT_SERVICE_PROFILE
Provide a default for
--service-profile
- IDF_COMPONENT_NAMESPACE
Provide a default for
--namespace
upload-status
Check the component uploading status.
compote component upload-status [OPTIONS]
Options
- --project-dir <manager>
- --service-profile <service_profile>
Profile for component registry to use.
- --job <job>
Required Upload job ID
Environment variables
- IDF_COMPONENT_SERVICE_PROFILE
Provide a default for
--service-profile
yank
Yank specified version of the component from the component registry. Yanked version will only be downloaded if the exact version is specified in the component manifest or lock file. A warning message is printed every time a yanked version is downloaded.
compote component yank [OPTIONS]
Options
- --project-dir <manager>
- --service-profile <service_profile>
Profile for component registry to use.
- --namespace <namespace>
Namespace for the component. Can be set in config file.
- --name <name>
Required Component name
- --version <version>
Required Component version to yank version.
- --message <message>
Required Message explaining why the component version is being removed from the registry.
Environment variables
- IDF_COMPONENT_SERVICE_PROFILE
Provide a default for
--service-profile
- IDF_COMPONENT_NAMESPACE
Provide a default for
--namespace
manifest
Group of commands to manage manifest of the project.
compote manifest [OPTIONS] COMMAND [ARGS]...
add-dependency
Add a dependency to the manifest file.
By default:
If you run the command in the directory with project, the dependency will be added to the manifest in the “main” directory.
If you run the command in the directory with a component, the dependency will be added to the manifest right in that directory.
You can explicitly specify directory using the --path option.
compote manifest add-dependency [OPTIONS] DEPENDENCY
Options
- --project-dir <manager>
- --service-profile <service_profile>
Profile for component registry to use.
- --component <component>
Component name in the project.
- -p, --path <path>
Path to the component. The component name is ignored when the path is specified.
Arguments
- DEPENDENCY
Required argument
Environment variables
- IDF_COMPONENT_SERVICE_PROFILE
Provide a default for
--service-profile
create
Create manifest file for the specified component.
By default:
If you run the command in the directory with project, the manifest will be created in the “main” directory.
If you run the command in the directory with a component, the manifest will be created right in that directory.
You can explicitly specify directory using the --path option.
compote manifest create [OPTIONS]
Options
- --project-dir <manager>
- --component <component>
Component name in the project.
- -p, --path <path>
Path to the component. The component name is ignored when the path is specified.
schema
Print json schema of the manifest file idf_component.yml
compote manifest schema [OPTIONS]
project
Group of project related commands
compote project [OPTIONS] COMMAND [ARGS]...
create-from-example
Create a project from an example.
You can specify EXAMPLE in the format like: namespace/name=1.0.0:example
where “=1.0.0” is a version specification.
An example command:
compote project create-from-example example/cmp^3.3.8:cmp_ex
Namespace and version are optional in the EXAMPLE argument.
compote project create-from-example [OPTIONS] EXAMPLE
Options
- --project-dir <manager>
- --service-profile <service_profile>
Profile for component registry to use.
- -p, --path <path>
Path of the new project. The project will be created directly in the given folder if it is empty.
Arguments
- EXAMPLE
Required argument
Environment variables
- IDF_COMPONENT_SERVICE_PROFILE
Provide a default for
--service-profile
remove-managed-components
Remove the managed_components folder.
compote project remove-managed-components [OPTIONS]
Options
- --project-dir <manager>
registry
Group of commands to work with component registry
compote registry [OPTIONS] COMMAND [ARGS]...
login
Login to the component registry
compote registry login [OPTIONS]
Options
- --service-profile <service_profile>
Profile for component registry to use.
- --no-browser
Do not open browser and only print login URL to the terminal
- --description <description>
Description for the token for future reference
- --default-namespace <default_namespace>
Default namespace to use for the components
- --registry-url <registry_url>
URL of the registry to use
Environment variables
- IDF_COMPONENT_SERVICE_PROFILE
Provide a default for
--service-profile
logout
compote registry logout [OPTIONS]
Options
- --service-profile <service_profile>
Profile for component registry to use.
Environment variables
- IDF_COMPONENT_SERVICE_PROFILE
Provide a default for
--service-profile
sync
compote registry sync [OPTIONS] PATH
Options
- --service-profile <service_profile>
Profile for component registry to use.
- --project-dir <manager>
- --interval <interval>
Sets the frequency (in seconds) for component synchronization. If set to 0, the program will run once and terminate.
- -R, --recursive
Search components recursively
- --component <component>
Specify the components you want to upload to the mirror. Use multiple –component options for multiple components. Format: namespace/name<version_spec>. Example: example/cmp==1.0.0
Arguments
- PATH
Required argument
Environment variables
- IDF_COMPONENT_SERVICE_PROFILE
Provide a default for
--service-profile
version
Print version of the IDF Component Manager.
compote version [OPTIONS]