primitive
Table of Contents
Installation
pip install primitive
Configuration
Authenticate
primitive config
Register your Hardware
primitive hardware register
License
primitive is distributed under the terms of the MIT license.
Development Setup
For Primitive engineers, you may have these steps completed.
Python Setup
# install required libs for macos
xcode-select --install
# install brew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
# install fish
brew install fish
echo /usr/local/bin/fish | sudo tee -a /etc/shells
chsh -s /usr/local/bin/fish
# install fisher
brew install fisher
fisher install jorgebucaran/nvm.fish
# install git
brew install git
# set global info
git config --global user.email "<user@email.com>"
git config --global user.name “<firstName lastName>”
# install make
brew install make
fish_add_path /opt/homebrew/opt/make/libexec/gnubin
# install uv
curl -LsSf https://astral.sh/uv/install.sh | sh
uv python install
fish_add_path "$(uv python dir)/bin"
Repository Setup
Clone and run setup.
cd ~/Development/primitivecorp/
git clone git@github.com:primitivecorp/platform.git
cd platform/cli
make setup
With the backend and frontend development environments running, configure the CLI for local use.
# bash or zsh
source .venv/bin/activate
# fish
source .venv/bin/activate.fish
primitive --host localhost:8000 config --transport http
You can find or create a Primitive API token at http://localhost:3000/account/tokens
Please enter your Primitive API token: # create a token and copy the value here
Config created at '/Users/<user>/.config/primitive/credentials.json' on host 'localhost:8000'
# verify the configuration worked via
primitive --host localhost:8000 whoami
Logged in as <username>
Release Process
Version is defined in src/primitive/__about__.py. Bump it, merge to main, and CI handles the rest.
# From the cli/ directory:
make release # patch bump (0.2.x → 0.2.x+1)
make release BUMP=minor # minor bump (0.x.y → 0.x+1.0)
make release BUMP=major # major bump (x.y.z → x+1.0.0)
# Or from the monorepo root:
make cli-release # patch bump
make cli-release BUMP=minor # minor bump
make cli-release BUMP=major # major bump
After merging to main, the CLI: Publish workflow automatically:
- Detects the version change in
src/primitive/__about__.py - Creates a git tag (
v0.2.x) - Creates a GitHub Release with auto-generated notes
- Builds and publishes to PyPI via trusted publishing (OIDC)
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
primitive-0.4.34.tar.gz
(400.4 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
primitive-0.4.34-py3-none-any.whl
(246.3 kB
view details)
File details
Details for the file primitive-0.4.34.tar.gz.
File metadata
- Download URL: primitive-0.4.34.tar.gz
- Upload date:
- Size: 400.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1a7c46fe245803750a23f843febdca2bc30e9717f02f7e9c2e48222ecaaee542
|
|
| MD5 |
c4751acd738f06b3dd778e6dae0864a2
|
|
| BLAKE2b-256 |
dbbf9205b1ec815f1cfc98e64f4239918387f47317667ca34bf298fd72775f4b
|
Provenance
The following attestation bundles were made for primitive-0.4.34.tar.gz:
Publisher:
cli-publish.yml on primitivecorp/platform
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
primitive-0.4.34.tar.gz -
Subject digest:
1a7c46fe245803750a23f843febdca2bc30e9717f02f7e9c2e48222ecaaee542 - Sigstore transparency entry: 2280951428
- Sigstore integration time:
-
Permalink:
primitivecorp/platform@120336dd77d39d1be8bb274143fb70a1c3cca71a -
Branch / Tag:
refs/heads/main - Owner: https://github.com/primitivecorp
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
cli-publish.yml@120336dd77d39d1be8bb274143fb70a1c3cca71a -
Trigger Event:
push
-
Statement type:
File details
Details for the file primitive-0.4.34-py3-none-any.whl.
File metadata
- Download URL: primitive-0.4.34-py3-none-any.whl
- Upload date:
- Size: 246.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a4a29517786857e44221c285d347dd7576e53b0a1c0c38fcc9c80f08f2af8e15
|
|
| MD5 |
d80ede00a9001523f6b674dc6749cfc7
|
|
| BLAKE2b-256 |
2f25171bbe9ff9be026dbf9895d2e0dac2a68476eac0838d93ba5b4b407513b3
|
Provenance
The following attestation bundles were made for primitive-0.4.34-py3-none-any.whl:
Publisher:
cli-publish.yml on primitivecorp/platform
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
primitive-0.4.34-py3-none-any.whl -
Subject digest:
a4a29517786857e44221c285d347dd7576e53b0a1c0c38fcc9c80f08f2af8e15 - Sigstore transparency entry: 2280951451
- Sigstore integration time:
-
Permalink:
primitivecorp/platform@120336dd77d39d1be8bb274143fb70a1c3cca71a -
Branch / Tag:
refs/heads/main - Owner: https://github.com/primitivecorp
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
cli-publish.yml@120336dd77d39d1be8bb274143fb70a1c3cca71a -
Trigger Event:
push
-
Statement type:
