Documentation — Criminas

Getting Started

Welcome to Criminas! We build open source tools that empower developers and everyday users. Here's everything you need to get up and running.

Installation

Most Criminas tools are available through standard package managers or GitHub releases.

bash

# Clone any Criminas project
git clone https://github.com/criminas/{project}.git
cd {project}

# Follow project-specific setup
cat README.md

Contributing

All our projects are open source and we welcome contributions of all kinds.

bash

# Fork the repo, then:
git checkout -b feature/my-feature

# Make your changes, then submit a PR
git push origin feature/my-feature

CrimiRepo

In Development

The community-driven package repository for everyone. CrimiRepo is a universal package manager that makes installing, updating, and managing software simple.

Package Management

Search, install, and manage packages with simple commands.

bash

# Search for a package
crimirepo search {package-name}

# Install a package
crimirepo install {package-name}

# Update all packages
crimirepo update --all

# Remove a package
crimirepo remove {package-name}

Publishing Packages

Share your software with the community by publishing to CrimiRepo.

bash

# Initialize a package manifest
crimirepo init

# Validate your package
crimirepo validate

# Publish to the repository
crimirepo publish

Repository Configuration

Customize repositories and manage sources.

yaml

# ~/.config/crimirepo/config.yaml
repositories:
  - name: official
    url: https://repo.criminas.org
    priority: 1
  - name: community
    url: https://community.criminas.org
    priority: 2

auto_update: true
update_interval: 24h

Forge

In Development

Developer tools that accelerate your workflow. Forge provides a suite of CLI utilities, build tools, and project scaffolding for modern development.

Project Scaffolding

Bootstrap new projects with opinionated, production-ready templates.

bash

# Create a new project
forge new my-project --template web

# Available templates
forge templates list

# Create from custom template
forge new my-app --from github.com/user/template

Build System

Unified build commands across all your projects.

bash

# Build your project
forge build

# Run in development mode
forge dev

# Run tests
forge test

# Lint and format
forge lint --fix

Configuration

Configure Forge for your project with a simple config file.

toml

# forge.toml
[project]
name = "my-project"
version = "1.0.0"

[build]
target = "dist"
minify = true

[dev]
port = 3000
hot_reload = true

Nexus

In Development

Cloud infrastructure that just works. Nexus simplifies deployment, scaling, and management of applications across any cloud provider.

Deployment

Deploy applications with a single command.

bash

# Initialize Nexus in your project
nexus init

# Deploy to production
nexus deploy --env production

# Deploy with preview URL
nexus deploy --preview

# View deployment status
nexus status

Infrastructure Config

Define your infrastructure as code with Nexus manifests.

yaml

# nexus.yaml
app:
  name: my-app
  runtime: node-20

scaling:
  min_instances: 1
  max_instances: 10
  cpu_threshold: 80

networking:
  domain: app.example.com
  ssl: auto

Monitoring

Built-in monitoring and logging for deployed applications.

bash

# View live logs
nexus logs --follow

# Check resource usage
nexus metrics

# Set up alerts
nexus alerts add \
  --metric cpu \
  --threshold 90 \
  --notify email

Sentinel

Open source security for the modern web. Sentinel provides automated vulnerability scanning, dependency auditing, and security monitoring for your projects.

Vulnerability Scanning

Scan your codebase for known vulnerabilities and security issues.

bash

# Run a full security scan
sentinel scan

# Scan specific directory
sentinel scan --path ./src

# Generate security report
sentinel report --format html

# CI/CD integration
sentinel scan --ci --fail-on high

Dependency Auditing

Audit your project dependencies for known vulnerabilities.

bash

# Audit dependencies
sentinel audit

# Auto-fix vulnerabilities
sentinel audit --fix

# Check specific package
sentinel audit --package lodash

# Export audit report
sentinel audit --export sbom.json

Configuration

Customize Sentinel's scanning rules and thresholds.

yaml

# .sentinel.yaml
scan:
  severity: medium
  exclude:
    - "test/**"
    - "vendor/**"

notifications:
  slack: https://hooks.slack.com/...
  email: security@example.com

schedule:
  cron: "0 6 * * 1"  # Weekly Monday

Community & Resources

Join the Criminas community. Contribute, ask questions, and help shape the future of open source.

GitHub

Browse source code, file issues, and submit pull requests.

View on GitHub →

Contact

Questions, feedback, or partnership inquiries — reach out anytime.

Get in Touch →

Contributing Guide

Learn how to contribute to Criminas projects and join the team.

Read the Guide →