Skip to content

README.md

Latest commit

 

History

History
516 lines (383 loc) · 8.78 KB

README.md

File metadata and controls

516 lines (383 loc) · 8.78 KB
Raw

Examples

This directory contains example configurations and usage scenarios for MayR Labs CLI.

Command Examples

General Commands

Generate UUID

mayrlabs uuid
# Output: 550e8400-e29b-41d4-a716-446655440000

Generate Password

# Default 16 characters
mayrlabs password

# Custom length
mayrlabs password 32

Hash String

# Default SHA256
mayrlabs hash "my-secret-string"

# Specify algorithm
mayrlabs hash "my-string" --algorithm md5
mayrlabs hash "my-string" --algorithm sha1
mayrlabs hash "my-string" --algorithm sha256

License Management

Create MIT License

mayrlabs add-license --type mit --author "Your Name" --year 2025

Available License Types

  • mit - MIT License
  • apache2 - Apache License 2.0
  • gpl3 - GNU General Public License v3
  • bsd3 - BSD 3-Clause License

Editor Configuration

Generate .editorconfig

# For Go projects
mayrlabs editor-config go

# For JavaScript/TypeScript projects
mayrlabs editor-config javascript

# For Python projects
mayrlabs editor-config python

CI/CD Configuration

Generate GitHub Actions Workflow

mayrlabs ci --lang go --vcs github
mayrlabs ci --lang javascript --vcs github
mayrlabs ci --lang flutter --vcs github

Generate GitLab CI Configuration

mayrlabs ci --lang go --vcs gitlab

Code Formatting

Format Code

# Interactive mode (prompts for language)
mayrlabs format

# Direct language specification
mayrlabs format go
mayrlabs format javascript
mayrlabs format python

Environment File Management

Update .env.example from .env

mayrlabs env update-example

Update from specific source

mayrlabs env update-example .env.staging

Validate .env file

mayrlabs env validate

Arrange .env file by prefix

mayrlabs env arrange
mayrlabs env arrange .env.staging

Changelog Management

Create CHANGELOG.md

mayrlabs changelog create

Record New Version

mayrlabs changelog record v1.0.0 "Initial release"

Mark as Work in Progress

mayrlabs changelog record v1.1.0 "New features" --wip

Git Operations

Prune Stale Branches

mayrlabs git prune-stale

Flutter Commands

Create Build Scripts

mayrlabs flutter create-scripts

This creates several scripts in the scripts/ directory:

  • build-apk.sh - Build debug APK
  • build-apk-release.sh - Build release APK
  • build-appbundle.sh - Build App Bundle
  • build-ios.sh - Build iOS app
  • build-ipa.sh - Build IPA
  • clean.sh - Clean Flutter build
  • run-tests.sh - Run Flutter tests

PHP Commands

Fix Code Style

mayrlabs php cs-fix

Lint PHP Files

mayrlabs php lint

JavaScript Commands

Setup Prettier

mayrlabs js setup-prettier

Format with Prettier

mayrlabs js pretty

Bonus Commands

Get Motivational Quote

mayrlabs quote

Generate Random Integer

mayrlabs random-int
# Will prompt for min and max values

AI Features

Setup AI

# Setup your Gemini API key
mayrlabs ai-setup

Query AI

# Ask a question
mayrlabs ai "How do I implement a binary search tree in Go?"

# Multi-line input (if no query provided)
mayrlabs ai

Send File to AI

# Get AI review/analysis of a file
mayrlabs ai-file src/main.go

# Get help understanding code
mayrlabs ai-file complex-algorithm.py

Create AI Alias

# Create a short alias for ai command
mayrlabs ai-alias ask

# Now you can use:
ask "your question here"

Clear API Key

# Remove stored Gemini API key
mayrlabs ai-clear

Session Management

Start Regular Session

# Start a session with a summary
mayrlabs session-start "Implementing user authentication"

# Start without summary (will prompt)
mayrlabs session-start

Start Secure Session

# Start an encrypted session for sensitive work
mayrlabs secure-session-start "Security patch development"

# Will prompt for encryption password

List Sessions

# List all regular sessions
mayrlabs sessions

# List all secure sessions
mayrlabs secure-sessions

Manage Sessions

# Prune sessions older than 30 days
mayrlabs session-prune 30

# Clear all sessions (requires PIN)
mayrlabs session-clear

Alias Management

Create Alias

# Create an alias for mayrlabs
mayrlabs alias ml

# Now you can use 'ml' instead of 'mayrlabs'
ml version

List Aliases

# Show all created aliases
mayrlabs alias-list

Clear Aliases

# Remove all aliases (with confirmation)
mayrlabs alias-clear

DNS Management

Clear DNS Cache

mayrlabs dns-clear

Automatically detects your OS and runs the appropriate command:

  • macOS: sudo dscacheutil -flushcache
  • Linux: sudo systemd-resolve --flush-caches
  • Windows: ipconfig /flushdns

Keystore Creation

Create Android Keystore

mayrlabs create-keystore

Interactive prompts for:

  • Key alias
  • Keystore filename
  • Validity period

Workflow Examples

Setting Up a New Go Project

# Generate .editorconfig
mayrlabs editor-config go

# Create LICENSE
mayrlabs add-license --type mit --author "Your Name" --year 2025

# Generate CI/CD configuration
mayrlabs ci --lang go --vcs github

# Create CHANGELOG
mayrlabs changelog create

# Format code
mayrlabs format go

Setting Up a New JavaScript Project

# Generate .editorconfig
mayrlabs editor-config javascript

# Setup Prettier
mayrlabs js setup-prettier

# Create LICENSE
mayrlabs add-license --type mit --author "Your Name" --year 2025

# Generate CI/CD configuration
mayrlabs ci --lang javascript --vcs github

# Format code
mayrlabs js pretty

Managing Environment Files

# After adding new variables to .env
mayrlabs env update-example

# Validate the .env file
mayrlabs env validate

# Organize variables by prefix
mayrlabs env arrange

Flutter Project Setup

# Generate build scripts
mayrlabs flutter create-scripts

# Generate CI/CD
mayrlabs ci --lang flutter --vcs github

# Create .editorconfig
mayrlabs editor-config dart

# Create LICENSE
mayrlabs add-license --type mit --author "Your Name" --year 2025

AI-Assisted Development Workflow

# Setup AI once
mayrlabs ai-setup

# Start a development session
mayrlabs session-start "Building REST API"

# Get help from AI during development
mayrlabs ai "How do I handle concurrent requests in Go?"

# Review code with AI
mayrlabs ai-file src/api/handler.go

# Create a short alias for faster queries
mayrlabs ai-alias ask

# Use the alias
ask "Best practices for error handling in Go?"

Secure Development Workflow

# Start an encrypted session for sensitive work
mayrlabs secure-session-start "Security vulnerability fix"

# Work on sensitive code...

# List your secure sessions later
mayrlabs secure-sessions

# Clean up old sessions
mayrlabs session-prune 30

Integration with Other Tools

Git Hooks

You can use MayR Labs CLI in Git hooks. For example, create .git/hooks/pre-commit:

#!/bin/bash
# Format code before commit
mayrlabs format go

CI/CD Integration

The generated CI/CD files are ready to use and include:

  • Dependency installation
  • Testing
  • Building
  • Linting

Makefile Integration

You can add MayR Labs CLI commands to your Makefile:

.PHONY: setup

setup:
	mayrlabs editor-config go
	mayrlabs add-license --type mit --author "Team" --year 2025
	mayrlabs ci --lang go --vcs github

Tips and Tricks

  1. Interactive Mode: Most commands support interactive mode if you omit required parameters
  2. Force Overwrite: Many file-generating commands support --force flag
  3. Help: Use --help with any command for detailed information
  4. Chaining: Combine with shell operators for powerful workflows
# Generate multiple files at once
mayrlabs editor-config go && \
mayrlabs add-license --type mit --author "Me" --year 2025 && \
mayrlabs changelog create

Common Use Cases

1. Quick Project Initialization

mayrlabs add-license --type mit --author "Your Name" --year 2025
mayrlabs editor-config go
mayrlabs ci --lang go --vcs github
mayrlabs changelog create

2. Environment Management

# Daily workflow
mayrlabs env validate
mayrlabs env arrange
mayrlabs env update-example

3. Code Maintenance

mayrlabs format go
mayrlabs git prune-stale

4. Security

# Generate secure password
mayrlabs password 32

# Generate hash for verification
mayrlabs hash "important-data" --algorithm sha256

Need Help?

Run any command with --help for detailed usage:

mayrlabs --help
mayrlabs ci --help
mayrlabs env --help