Skip to content

Release Notes

This document tracks version history and changes to SPEAR. We use Semantic Versioning (MAJOR.MINOR.PATCH).

Version 1.0.0

Initial Release

Core Modules

Sales & Scoping

Client management with contact tracking
Scoping workbench for engagement planning
Public portal for client scope review and approval
Sales pipeline with deal tracking
SOW generation with customizable templates

Project Management

Project creation and lifecycle management
Resource scheduling and assignment
Status report generation
Timeline and milestone tracking

Operations

Asset management with bulk import
Vulnerability tracking and assignment
Physical security assessment workflows
Scanner import support (Burp Suite, NodeZero, Nexpose, BloodHound, Atlas)

Reporting

Real-time collaborative editing powered by Y.js
Rich text editor with formatting controls
Findings library for reusable vulnerability content
Content library for standard sections and boilerplate
PDF and DOCX export with custom branding
Public report delivery portal

Metrics Dashboard

Project statistics and KPIs
Team utilization tracking
Finding severity distribution
Engagement timeline visualization

Administration

Role-based access control (RBAC) with groups
OAuth2/SSO support (Google, Microsoft, GitHub, Okta)
Custom branding (logos, colors, fonts)
Service configuration (SMTP, AI, storage)
Automated backup scheduling
Audit logging and security monitoring

Platform Features

Cross-platform binaries: Linux, Windows, macOS (amd64/arm64)
Self-hosted: Complete data sovereignty
Single binary deployment: No external dependencies
Embedded database: SQLite with automatic migrations
API access: Full REST API for automation

Security

Field-level encryption for sensitive data
CSRF protection
Rate limiting
Secure session management
Audit trail logging

Upgrade Guide

From Pre-release Versions

If upgrading from a pre-release or development version:

Backup your data
Terminal window
```
cp -r pb_data pb_data_backup
```
Download the new release
Stop the current instance
Replace the binary
Start the new version
Terminal window
```
./spear serve
```

Migrations run automatically on startup.

Versioning Policy

SPEAR follows semantic versioning:

MAJOR (1.x.x): Breaking changes requiring migration steps
MINOR (x.1.x): New features, backward compatible
PATCH (x.x.1): Bug fixes, security patches

Release Channels

Stable: Production-ready releases
Beta: Feature-complete, testing phase
Dev: Latest development builds (not recommended for production)

Changelog Format

Each release documents changes in these categories:

Added: New features
Changed: Changes to existing functionality
Fixed: Bug fixes
Deprecated: Features marked for future removal
Removed: Features removed in this release
Security: Security-related changes

Reporting Issues

Found a bug or have a feature request?

Check existing GitHub issues
Open a new issue with:
- SPEAR version (./spear --version)
- Operating system and architecture
- Steps to reproduce
- Expected vs actual behavior

This is a living document updated with each release.