SoCX CLI

SoCX is a command-line toolbox for EDA development teams.

SoCX can also be used in your own python project/library/script and provides an extensive API with many useful features targeted at EDA development.

For details, please refer to the official documentation page.

Installation

[!IMPORTANT] ensure you meet the following perquisites before proceeding with the installation of socx:

• A working installation of pip or uv.
• A working installation of Python 3.12 or newer version.

Install as a tool

with uv:

uv tool install socx-cli

with pip:

pipx install socx-cli

Run directly (without an installation)

with uv:

uvx --from socx-cli socx

with pip:

pipx run --spec socx-cli socx

Add to your python project

with uv:

uv add socx-cli

with pip:

pip install socx-cli
pip freeze -r requirements.txt

Upgrading to the Latest Version

with uv:

uv tool update socx-cli

with pip:

pipx upgrade socx-cli

[!TIP] You can run the below command to verify socx was properly installed.

$ socx version
Name: socx-cli
Version: 0.11.5
Summary: System on chip verification and tooling infrastructure.
Home-page: https://sagikimhi.dev/socx-cli
Author:
Author-email: Sagi Kimhi <sagi.kim5@gmail.com>
License-Expression: Apache-2.0
Location: /home/skimhi/.project/git/users/sagikimhi/python/socx-worktree/develop/.venv/lib/python3.14/site-packages
Editable project location: /home/skimhi/.project/git/users/sagikimhi/python/socx-worktree/develop
Requires: click, copier, dynaconf, gitpython, hoptex, jinja2, paramiko, pip,
platformdirs, plumbum, prompt-toolkit, psutil, pydantic, pygit2, python-box,
rich, rich-click, sh, textual, textual-speedups, typer, uv, werkzeug
Required-by:

Documentation & Community

• Project Documentation: https://sagikimhi.dev/socx-cli
• Community Discussions: https://gitter.im/socx-cli/community

License

Licensed under Apache-2.0.

See LICENSE for details.