Agent skill
b2c-job
Run and monitor existing (B2C/demandware/SFCC) jobs using the b2c cli, import/export site archives (IMPEX). Always reference when using the CLI to run jobs, import or export site archives, check job execution status, or trigger search indexing. For creating new jobs, use b2c-custom-job-steps skill instead.
Install this agent skill to your Project
npx add-skill https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/tree/main/skills/b2c-cli/skills/b2c-job
SKILL.md
B2C Job Skill
Use the b2c CLI plugin to run existing jobs and import/export site archives on Salesforce B2C Commerce instances.
Tip: If
b2cis not installed globally, usenpx @salesforce/b2c-cliinstead (e.g.,npx @salesforce/b2c-cli job run).
Creating a new job? If you need to write custom job step code (batch processing, scheduled tasks, data sync), use the
b2c:b2c-custom-job-stepsskill instead.
Examples
Run a Job
# run a job and return immediately
b2c job run my-custom-job
# run a job and wait for completion
b2c job run my-custom-job --wait
# run a job with a timeout (in seconds)
b2c job run my-custom-job --wait --timeout 600
# run a job with parameters (standard jobs)
b2c job run my-custom-job -P "SiteScope={\"all_storefront_sites\":true}" -P OtherParam=value
# show job log if the job fails
b2c job run my-custom-job --wait --show-log
Run System Jobs with Custom Request Bodies
Some system jobs (like search indexing) use non-standard request schemas. Use --body to provide a raw JSON request body:
# run search index job for specific sites
b2c job run sfcc-search-index-product-full-update --wait --body '{"site_scope":["RefArch","SiteGenesis"]}'
# run search index job for a single site
b2c job run sfcc-search-index-product-full-update --wait --body '{"site_scope":["RefArch"]}'
Note: --body and -P are mutually exclusive.
Import Site Archives
The job import command automatically waits for the import job to complete before returning. It does not use the --wait option.
# import a local directory as a site archive
b2c job import ./my-site-data
# import a local zip file
b2c job import ./export.zip
# keep the archive on the instance after import
b2c job import ./my-site-data --keep-archive
# import an archive that already exists on the instance (in Impex/src/instance/)
b2c job import existing-archive.zip --remote
# show job log on failure
b2c job import ./my-site-data --show-log
Export Site Archives
# export site data using the job export command
b2c job export
Search Job Executions
# search for job executions
b2c job search
# search with JSON output
b2c job search --json
Wait for Job Completion
# wait for a specific job execution to complete
b2c job wait <execution-id>
More Commands
See b2c job --help for a full list of available commands and options in the job topic.
Related Skills
b2c:b2c-custom-job-steps- For creating new custom job steps (batch processing scripts, scheduled tasks, data sync jobs)b2c-cli:b2c-site-import-export- For site archive structure and metadata XML patterns
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
api-client-development
Creating typed API clients with OpenAPI specs, authentication, and OAuth scopes for SCAPI and similar APIs. Use when adding a new SCAPI client, generating types from an OpenAPI spec, setting up OAuth middleware, or integrating a new Commerce API endpoint.
testing
Writing tests for the B2C CLI project using Mocha, Chai, and MSW. Use when writing unit or integration tests, mocking HTTP requests with MSW, testing CLI commands with oclif, isolating config in tests, setting up test coverage, using sinon stubs, c8 coverage, capturing or silencing stdout, or creating MSW handlers.
documentation
Updating user guides, CLI reference, and API documentation for the B2C CLI project. Use when adding or changing CLI command docs, writing JSDoc for TypeDoc generation, updating Vitepress sidebar config, or creating new guide pages.
cli-command-development
Creating new CLI commands and topics for the B2C CLI using oclif. Use when adding a new command, creating a topic, adding flags or arguments, implementing table output, or extending BaseCommand/OAuthCommand/InstanceCommand.
sdk-module-development
Adding new modules and exports to the @salesforce/b2c-tooling-sdk package. Use when creating a new SDK module, adding barrel file exports, configuring package.json exports, or building client factory functions.
b2c-code
Deploy and manage code versions/cartridges on B2C Commerce instances/sandboxes with the b2c cli. Always reference when using the CLI to upload cartridges, deploy code, activate code versions, manage code versions, or watch for file changes during development.
Didn't find tool you were looking for?