chipctx
v0.2.2
Published
CLI tool for CMSIS-based embedded project development
Readme
chipctx
ChipCtx CLI for CMSIS-based embedded project workflows.
- Discover boards/devices and resolve required CMSIS packs
- Initialize project scaffolds from board/device context
- Build with CMSIS-Toolbox + Arm GNU Toolchain
- Manage pack sources and toolbox setup
Install
npm install -g chipctxRequirements:
- Node.js
>=18
Quick Start
# 1) Install toolbox/toolchain dependencies (one-time)
chipctx setup
# 2) Load toolchain environment in current shell
source ~/.chipctx/env.sh
# 3) Create a project from board metadata
chipctx project init --board NUCLEO-G431RB --examples Blinky -v
# 4) Build
chipctx buildCommon Commands
# Check toolbox readiness
chipctx toolbox check
# Initialize by board or device
chipctx project init --board NUCLEO-G431RB --examples Blinky
chipctx project init --device STM32G431RBTx --examples Blinky
# Build and flash
chipctx build
chipctx flash
# Manage pack index sources
chipctx sources list
chipctx sources update
# Search local pack index
chipctx pack search Tai-ActionConfiguration
Default config file:
~/.chipctx/config.tomlUseful global flags:
chipctx --api-url <url> ...
chipctx --json ...
chipctx -v ...Troubleshooting
If global install fails with EACCES, use a user-level npm prefix:
mkdir -p ~/.npm-global
npm config set prefix ~/.npm-global
echo 'export PATH="$HOME/.npm-global/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
npm install -g chipctxIf build tools are not found in the current shell:
source ~/.chipctx/env.shAfter chipctx setup succeeds, chipctx automatically runs chipctx sources update
to refresh the local pack index cache.
Links
- npm: https://www.npmjs.com/package/chipctx
- Web: https://chipctx.com
