Nexula CLI
Enterprise-grade CLI for Nexula AI Supply Chain Security Platform.
Installation
cd nexula-cli
pip install -e .
Quick Start
1. Authentication
Login with your API key (generate from dashboard):
nexula auth login
# Enter API key when prompted
Check authentication status:
nexula auth whoami
2. Initialize Project
Initialize Nexula in your AI/ML project directory:
cd /path/to/your/ai-project
nexula init
This will:
- List available workspaces
- Let you select or create a project
- Save configuration to
.nexula.yaml
3. Generate AIBOM
Generate AI Bill of Materials (discovers all AI/ML assets):
nexula aibom generate
List AIBOMs:
nexula aibom list
View AIBOM details:
nexula aibom view <aibom-id>
4. Run Security Scan
Run comprehensive security scan:
nexula scan run --wait
Run specific scanners:
nexula scan run --scanners sast --scanners cve --wait
Check scan status:
nexula scan status <scan-id>
View scan results:
nexula scan results <scan-id>
List all scans:
nexula scan list
Available Scanners
sast- Static Application Security Testingcve- CVE/Vulnerability Detectionsecrets- Secrets Detectionml_poisoning- ML Model Poisoning Detectiondataset_poisoning- Dataset Poisoning Detectionllm_security- LLM Security Analysisrag_security- RAG Security Analysismodel_provenance- Model Provenance Verificationcontainer_registry- Container Registry Securitylicense- License Compliance
Configuration
Global Config (~/.nexula/config.yaml)
Stores:
- API key (encrypted)
- API URL
- User preferences
Project Config (.nexula.yaml)
Stores:
- Workspace ID
- Project ID
- Project-specific settings
Commands Reference
Auth Commands
nexula auth login # Login with API key
nexula auth logout # Logout and clear credentials
nexula auth whoami # Show current user
Project Commands
nexula init # Initialize project
nexula init --create # Create new project
nexula init --workspace-id 1 # Use specific workspace
AIBOM Commands
nexula aibom generate # Generate AIBOM
nexula aibom generate --path . # Specify path
nexula aibom list # List AIBOMs
nexula aibom view <id> # View AIBOM details
Scan Commands
nexula scan run # Run all scanners
nexula scan run --wait # Wait for completion
nexula scan run --scanners sast --scanners cve # Specific scanners
nexula scan status <id> # Check status
nexula scan results <id> # View results
nexula scan results <id> --format json # JSON output
nexula scan list # List scans
CI/CD Integration
GitHub Actions
name: Nexula Security Scan
on: [push, pull_request]
jobs:
security-scan:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install Nexula CLI
run: pip install nexula-cli
- name: Run Security Scan
env:
NEXULA_API_KEY: ${{ secrets.NEXULA_API_KEY }}
run: |
echo "$NEXULA_API_KEY" | nexula auth login --api-key -
nexula init --workspace-id 1 --project-id 1
nexula aibom generate
nexula scan run --wait
GitLab CI
nexula-scan:
image: python:3.11
script:
- pip install nexula-cli
- echo "$NEXULA_API_KEY" | nexula auth login --api-key -
- nexula init --workspace-id 1 --project-id 1
- nexula aibom generate
- nexula scan run --wait
variables:
NEXULA_API_KEY: $NEXULA_API_KEY
Environment Variables
NEXULA_API_KEY- API key (alternative to interactive login)NEXULA_API_URL- API URL (default: http://localhost:8000/api/v1)
Troubleshooting
Authentication Issues
# Clear credentials and re-login
nexula auth logout
nexula auth login
Project Not Found
# Re-initialize project
nexula init
API Connection Issues
# Check API URL
nexula auth whoami
# Set custom API URL
nexula auth login --api-url https://api.nexula.one/api/v1
Support
- Documentation: https://docs.nexula.one
- Dashboard: https://cloud.nexula.one
- Issues: https://github.com/nexula/nexula-cli/issues
Metadata
Release files for nexula-cli 2.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| nexula_cli-2.0.4.tar.gz | 51.7 kB | Without provenance | Details for nexula_cli-2.0.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| nexula_cli-2.0.4-py3-none-any.whl | Python 3 | none | any | Details for nexula_cli-2.0.4-py3-none-any.whl |
Total release size: 115.5 kB
Release files / nexula_cli-2.0.4.tar.gz
| Download URL | nexula_cli-2.0.4.tar.gz |
|---|---|
| Size | 51.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f7e7b5dc37d3ed9c37f414d09e2717ed204f7c05c730e63ef4fa28463510cec8
|
|
BLAKE2b-256 checksum How to use checksums |
d98bb8e0791293bb9d85493c0c726d69fb8d81ade224389165d87001f2e0383e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.9
|
Release files / nexula_cli-2.0.4-py3-none-any.whl
| Download URL | nexula_cli-2.0.4-py3-none-any.whl |
|---|---|
| Size | 63.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b8ec929ea0df042e7693d2b03b76d7b64ed9d7c21a36214cb9eb8494ffe5cf0e
|
|
BLAKE2b-256 checksum How to use checksums |
6e41e53406ea0757b4b697152767d3e7e3a4e8f7c3569f213f6e18d54ee64b45
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.9
|
Security for nexula-cli 2.0.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.