HomeBlogContactSupport
Currency
Language
RegisterSign In
CLI Documentation

Build faster with Source Parts CLI

Install, authenticate, and automate your entire sourcing workflow with our component-focused command line toolkit.

Install the CLIOpen CLI repositoryTalk with solutions team

GitHub

Browse source, releases, and issue tracker.

Installation

Step-by-step environment setup.

Command reference

Search every CLI command by category.

Support

Submit tickets or reach the team.

Install the CLI for your environment

Use one command to install on macOS, Linux, or Windows and authenticate with Source Parts.

Copy a command to get started
Choose your operating system
Run the command in your terminal and follow the prompts to authenticate with Source Parts.
curl -fsSL https://source.parts/cli/install.sh | bash

Need a different platform? Visit the GitHub repository for container images and build instructions.

Authenticate in minutes

Enforce the same security standards used across the Source Parts platform.

Generate scoped API keys
Issue keys per environment with role-based permissions and automatic expiration.
Assign least-privileged scopes
Map CLI profiles to Source Parts roles to control read, write, and approval access.
Automate key rotation
Rotate credentials on a schedule using built-in renewal commands and policy reminders.

Command reference

Explore the core command families that power sourcing, quoting, and fulfillment workflows.

Search & intelligence
Query millions of components, analyze lifecycle risk, and export pricing snapshots.
CLI

components search

Search the Source Parts catalog with filters for stock, manufacturer, compliance, and lifecycle status.

parts components search --query "stm32f4" --in-stock

components lifecycle

Inspect lifecycle events, alternates, and risk signals for critical components.

parts components lifecycle --mpn ESP32-C3

inventory availability

Return regional inventory, lead times, and allocation windows in real time.

parts inventory availability --sku 100-443-ESP32 --region us
Quotes & commerce
Automate quoting, BOM uploads, and purchase order workflows.
CLI

quotes create

Upload BOM files, apply pricing tiers, and generate shareable quotes.

parts quotes create --file ./bom.csv --customer-id 98213

orders submit

Convert approved quotes to orders with payment terms and shipment preferences.

parts orders submit --quote Q-14233 --method net-30

fulfillment track

Monitor fulfillment milestones, logistics updates, and delivery ETA.

parts fulfillment track --order SO-55821
Automation & integrations
Connect the CLI to CI pipelines, schedulers, and downstream systems.
CLI

automation workflows run

Execute saved workflows that bundle multiple commands with approvals and notifications.

parts automation workflows run nightly-replenishment

integrations sync

Synchronize Source Parts data with ERP, PLM, or data warehouses.

parts integrations sync --target erp

audit log export

Export command history with user, timestamp, and result metadata for compliance review.

parts audit log export --since 7d --format csv

Automation recipes

Kickstart your workflows with ready-to-run examples you can adapt to your environment.

Monitor lifecycle risk
Schedule a job that flags lifecycle changes and sends alerts to Slack.
#!/bin/bash
parts components lifecycle --mpn $1 --json | jq '.alerts[]' | slackctl send --channel sourcing-alerts
Sync BOM alternates
Update engineering alternates nightly and persist results to your PLM.
parts quotes bom-sync --project ${PROJECT_ID} | plmctl import --workspace hardware
Gate releases in CI
Fail builds when BOM risk exceeds tolerance before merging to main.
parts automation evaluate --workflow ci-bom-check || exit 1

Configure once, reuse everywhere

Profiles let teams share connections while keeping secrets secure.

Key configuration fields
Define defaults in ~/.sourceparts/config.json or set environment overrides for CI.
Profiles

profile

Named profile used to scope credentials and default workspace settings.

{"default": "production"}

workspaceId

Source Parts workspace identifier used to fetch quotes, orders, and analytics.

{"workspaceId": "org-sp-enterprise"}

output.format

Control the default response format across commands (json, table, csv).

{"output": { "format": "table" }}
Reference the REST API
Pair CLI automation with direct API calls for custom integrations.
Open API reference
Explore full examples
See how teams embed Source Parts into dashboards, pipelines, and ERP systems.
View example repository

Frequently asked questions

Answers for rollout, security, and day-to-day operations.

Operational excellence from the command line

Deploy sourcing automation in days, not quarters, with the Source Parts CLI.

Create Source Parts accountBrowse API documentationSchedule a strategy session
CLI Documentation - Source Parts Command Line Interface | Source Parts