home / skills / salesforcecommercecloud / b2c-developer-tooling / b2c-webdav

This skill helps you manage files on B2C Commerce WebDAV from the command line, enabling listing, uploading, downloading, and folder operations.

npx playbooks add skill salesforcecommercecloud/b2c-developer-tooling --skill b2c-webdav

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
3.4 KB
---
name: b2c-webdav
description: List, upload, download, and manage files on B2C Commerce instances via WebDAV with the b2c cli. Use when uploading to IMPEX directories, downloading files, managing files in cartridges/catalogs/static/temp folders, creating directories, or zipping/unzipping remote files. For log exploration and tailing, use b2c-logs instead.
---

# B2C WebDAV Skill

Use the `b2c` CLI plugin to perform WebDAV file operations on Salesforce B2C Commerce instances. This includes listing files, uploading, downloading, and managing files across different WebDAV roots.

> **Tip:** If `b2c` is not installed globally, use `npx @salesforce/b2c-cli` instead (e.g., `npx @salesforce/b2c-cli webdav ls`).

## WebDAV Roots

The `--root` flag specifies the WebDAV directory:
- `impex` (default) - Import/Export directory
- `temp` - Temporary files
- `cartridges` - Code cartridges
- `realmdata` - Realm data
- `catalogs` - Product catalogs
- `libraries` - Content libraries
- `static` - Static resources
- `logs` - Application logs
- `securitylogs` - Security logs

## Examples

### List Files

```bash
# list files in the default IMPEX root
b2c webdav ls

# list files in a specific path
b2c webdav ls src/instance

# list files in the cartridges root
b2c webdav ls --root=cartridges

# list files with JSON output
b2c webdav ls --root=impex --json
```

### Download Files

```bash
# download a file from IMPEX (default root)
b2c webdav get src/instance/export.zip

# download to a specific local path
b2c webdav get src/instance/export.zip -o ./downloads/export.zip

# download from a specific root
b2c webdav get customerror.log --root=logs

# output file content to stdout
b2c webdav get src/instance/data.xml -o -
```

### Upload Files

```bash
# upload a file to IMPEX
b2c webdav put ./local-file.zip src/instance/

# upload to a specific root
b2c webdav put ./my-cartridge.zip --root=cartridges
```

### Create Directories

```bash
# create a directory in IMPEX
b2c webdav mkdir src/instance/my-folder

# create a directory in a specific root
b2c webdav mkdir my-folder --root=temp
```

### Delete Files

```bash
# delete a file
b2c webdav rm src/instance/old-export.zip

# delete from a specific root
b2c webdav rm old-file.txt --root=temp
```

### Delete Cartridges

To delete cartridges from a code version, use the `cartridges` root with the path format `{code-version}/{cartridge-name}`:

```bash
# delete a cartridge from a code version
b2c webdav rm v25_1_0/app_mysite --root=cartridges

# delete multiple cartridges
b2c webdav rm v25_1_0/app_mysite --root=cartridges
b2c webdav rm v25_1_0/int_myintegration --root=cartridges

# list cartridges in a code version first
b2c webdav ls v25_1_0 --root=cartridges
```

**Important:** The path is `{code-version}/{cartridge-name}`, not `/cartridges/{code-version}/...`. The `--root=cartridges` (or `-r cartridges`) flag sets the WebDAV root.

### Zip/Unzip Remote Files

```bash
# create a zip archive of a remote directory
b2c webdav zip src/instance/my-folder

# extract a remote zip archive
b2c webdav unzip src/instance/archive.zip
```

### More Commands

See `b2c webdav --help` for a full list of available commands and options in the `webdav` topic.

## Related Skills

- `b2c-cli:b2c-logs` - Filtered log retrieval, search, and real-time tailing (preferred for log exploration)
- `b2c-cli:b2c-code` - Higher-level code deployment (preferred for cartridge upload)
- `b2c-cli:b2c-job` - Import/export site archives

Overview

This skill provides WebDAV file management for Salesforce B2C Commerce instances via the b2c CLI. It lets you list, download, upload, create directories, delete, and zip/unzip files across WebDAV roots such as impex, cartridges, catalogs, static, and logs. Use it to script or interactively manage files on instance file systems when working with imports, cartridges, catalogs, or temporary storage.

How this skill works

The skill operates as a b2c CLI plugin under the webdav topic and targets different WebDAV roots via the --root flag (impex, cartridges, temp, catalogs, static, logs, etc.). Commands include ls, get, put, mkdir, rm, zip, and unzip, with options for JSON output, custom local paths, and stdout streaming. It works equally well with npx if the b2c CLI is not installed globally.

When to use it

  • Upload or download IMPEX files for imports and exports.
  • Manage cartridges and code version directories on the cartridges root.
  • Inspect or manipulate files in catalogs, static assets, or libraries.
  • Create temporary folders, remove stale files, or manage realmdata.
  • Zip or unzip remote directories without downloading locally first.

Best practices

  • Prefer b2c-logs for log exploration and real-time tailing instead of using the logs WebDAV root.
  • List a target path (b2c webdav ls) before destructive actions like rm to avoid accidental deletions.
  • Use the correct root flag; cartridge paths must be specified as {code-version}/{cartridge-name} when using --root=cartridges.
  • Stream files to stdout (-o -) for quick inspections in scripts or CI without creating temp files.
  • Use JSON output for machine parsing when automating workflows (b2c webdav ls --json).

Example use cases

  • Upload a new cartridge archive into the cartridges root prior to deployment.
  • Download an exported site archive from impex for local processing or backup.
  • Create a temp directory and upload transient files needed by an import job.
  • Remove old exports or temporary files to reclaim space on the instance.
  • Zip a remote folder of static assets to transfer or inspect as a single archive.

FAQ

How do I delete a cartridge from a code version?

Use the cartridges root and the path format {code-version}/{cartridge-name}, e.g. b2c webdav rm v25_1_0/app_mysite --root=cartridges.

Can I use the CLI without installing b2c globally?

Yes. Run commands with npx @salesforce/b2c-cli webdav <command> if the CLI is not installed globally.