Skip to content

stefan-kp/n2b

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

73 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

N2B - AI-Powered Code Analysis & Jira Integration

Gem Version

Transform your development workflow with intelligent command translation, code analysis, and seamless Jira/GitHub integration. N2B provides a suite of tools to enhance productivity.

IMPORTANT: Command Restructuring in v2.0

The n2b and n2b-diff commands have been restructured in version 2.0.

  • n2b is now solely for natural language to shell command translation.
  • n2b-diff handles both AI-powered merge conflict resolution AND AI-powered code diff analysis (previously n2b --diff).

Please see our MIGRATION.md for details on adapting your commands and workflows.

Transform your development workflow with intelligent code analysis and seamless Jira integration. N2B is an AI-powered development tool that revolutionizes code review, requirements compliance, and project management through automated diff analysis, smart merge conflict resolution, and intelligent ticket integration.

🚀 Key Features

🎯 Smart Jira & GitHub Integration (via n2b-diff --analyze)

  • Automated Ticket/Issue Analysis: Fetch requirements from Jira tickets or GitHub issues and analyze code changes against them using n2b-diff --analyze.
  • Intelligent Updates: Post beautifully formatted analysis results directly to Jira or GitHub.
  • Requirements Extraction: Automatically identify acceptance criteria and tasks.
  • Real-time Feedback: Get instant compliance checking.

🔍 AI-Powered Code Diff Analysis (via n2b-diff --analyze)

  • Context-Aware Diff Review: Intelligent analysis of git/hg changes.
  • Requirements Compliance: Automated verification against project requirements.
  • Test Coverage Assessment: Evaluate test completeness.
  • Security & Quality Insights: Identify potential issues and improvements.
  • Custom Instructions: Guide the AI analysis with the -m/--message option.

コマンド変換 (via n2b)

  • Natural Language to Shell: Convert descriptions to executable shell commands.

🤖 Flexible AI Support

  • Multiple LLM Providers: Claude, OpenAI, Gemini, OpenRouter, Ollama.
  • Latest Models: Support for cutting-edge models from various providers.
  • Custom Models: Use fine-tuned models and custom deployments.

💻 Development Workflow

  • AI Merge Conflict Resolution (via n2b-diff): Interactive merge conflict resolver with HTML audit logs.
  • HTML Merge Logs: Beautiful 4-column audit trails with base/incoming/resolution/reasoning.
  • Ruby Code Generation (IRB/Console): Generate Ruby code from natural language.
  • VCS Integration: Git and Mercurial support in n2b-diff.
  • Errbit Integration (IRB/Console): Analyze errors and generate reports.

🔍 AI-Powered Diff Analysis with n2b-diff --analyzeBeta Feature

Get instant, intelligent code review for every change you make. The n2b-diff --analyze command provides comprehensive insights into your code changes, helping you catch issues early and maintain high code quality.

What Makes It Special

  • 🧠 Context-Aware Analysis: Understands your codebase patterns and architectural decisions
  • 🎯 Requirements Compliance: Automatically checks if changes meet specified requirements
  • 🔍 Deep Code Review: Identifies potential bugs, security issues, and performance problems
  • 💡 Smart Suggestions: Provides actionable improvement recommendations with file/line references
  • 📊 Test Coverage: Evaluates test completeness and suggests missing test scenarios
  • 🚀 Lightning Fast: Get comprehensive analysis in seconds, not hours

🚀 Quick Start

# Analyze your current changes
n2b-diff --analyze

# Compare against main branch with requirements checking and a custom message
n2b-diff --analyze --branch main --requirements requirements.md -m "Focus on security aspects"

# Full workflow with Jira integration
n2b-diff --analyze --jira PROJ-123 --update

💬 We Want Your Feedback!

This is a beta feature and we're actively improving it based on real-world usage. Your feedback is invaluable! Please share your experience:


🎯 Jira & GitHub Integration with n2b-diff --analyze

Transform your development workflow with intelligent Jira and GitHub issue integration:

Quick Setup

# Install and configure
gem install n2b
n2b --advanced-config  # Set up Jira credentials

# Test your connection
n2b-test-jira # (This command might need review if its scope changes)

# Analyze code against ticket requirements
n2b-diff --analyze --jira PROJ-123 --update

# Analyze code against GitHub issue requirements
n2b-diff --analyze --github your-org/your-repo/issues/42 --update

What You Get

  1. 📥 Smart Ticket Analysis: Automatically fetches requirements, acceptance criteria, and comments from Jira
  2. 🔍 Intelligent Code Review: AI analyzes your changes against ticket requirements
  3. 📤 Structured Updates: Posts beautifully formatted analysis back to Jira with collapsible sections
  4. ✅ Requirements Compliance: Clear status on what's implemented, partially done, or missing

Example Workflow

# Working on ticket PROJ-123
git add .
n2b-diff --analyze --jira PROJ-123 --update

Result: Your Jira ticket (or GitHub issue) gets updated with a professional analysis comment showing implementation progress, technical insights, and compliance status.

📊 HTML Merge Logs - Professional Audit Trails

N2B now generates beautiful HTML merge logs that provide complete audit trails of your merge conflict resolutions:

4-Column Layout

  • Base Branch Code: The code from your target branch
  • Incoming Branch Code: The code from the branch being merged
  • Final Resolution: The actual resolved code that was chosen
  • Resolution Details: Method used, timestamps, and LLM reasoning

🎨 Professional Features

  • Color-Coded Sections: Red for base, blue for incoming, green for resolution
  • Method Badges: Visual indicators for LLM vs Manual vs Skip vs Abort
  • Statistics Dashboard: Total conflicts, resolved count, success rates
  • Responsive Design: Works perfectly on desktop and mobile
  • Browser-Ready: Open directly in any web browser

📋 Perfect for Teams

  • Code Reviews: Share merge decisions with your team
  • Compliance: Complete audit trail for regulated environments
  • Learning: See how AI suggestions compare to manual choices
  • Debugging: Understand why conflicts were resolved specific ways

🚀 Usage

# Enable merge logging in config (if not already enabled)
n2b -c

# Resolve conflicts - HTML log automatically generated
n2b-diff conflicted_file.rb

# Find your logs
open .n2b_merge_log/2025-01-08-143022.html

🔍 AI-Powered Code Analysis & Command Translation

N2B offers two primary commands for different aspects of your workflow:

1. n2b (Natural Language to Shell Commands) Use n2b for translating your plain English (or other language) descriptions into shell commands.

n2b "list all ruby files modified in the last 2 days"
n2b -x "create a backup of my_app.log"

2. n2b-diff (Merge Conflict Resolution & Diff Analysis) Use n2b-diff for AI-assisted merge conflict resolution and for detailed AI-powered analysis of your code changes (diffs).

Diff Analysis Examples:

# Analyze uncommitted changes
n2b-diff --analyze

# Compare against specific branch with requirements and custom message
n2b-diff --analyze --branch main --requirements requirements.md -m "Ensure all new functions are documented."

# Full workflow with Jira integration
n2b-diff --analyze --jira PROJ-123 --requirements specs.md --update

🆕 What's New in v2.0.1 (Latest)

  • 📊 HTML Merge Logs: Beautiful 4-column audit trails with professional styling and team collaboration features
  • 🎯 Enhanced Jira Integration: Template-based formatting, collapsible sections, and clean professional comments
  • 🔧 Debug Environment: N2B_DEBUG=true for detailed troubleshooting when needed
  • ⚡ Better Context Display: Shows surrounding code context for better conflict understanding
  • 🧪 Robust Testing: All core functionality thoroughly tested and passing

🆕 What's New in v2.0 (Major Release)

  • Command Restructuring: n2b for command translation, n2b-diff for merge conflicts and all-new AI diff analysis. See MIGRATION.md.
  • Custom Messages for Analysis: Guide the AI's focus during diff analysis using the -m/--message option with n2b-diff --analyze.
  • Enhanced n2b-diff: Now the central hub for code analysis, supporting branches, requirements files, Jira/GitHub integration, and custom analysis instructions.
  • 🔗 GitHub Integration: Full GitHub issue support with fetch and comment functionality
  • 🔍 Enhanced AI Diff Analysis: Comprehensive code review with context-aware insights (Beta)
  • ☐ Interactive Jira Checklists: Native checkboxes for team collaboration and progress tracking
  • 🎯 Full Template Engine: Variables, loops, conditionals for maximum customization
  • 🚨 Smart Error Classification: Automatic severity detection (Critical/Important/Low)
  • 📁 Editor Integration: Open conflicted files in your preferred editor with change detection
  • 🛡️ JSON Auto-Repair: Automatically fixes malformed LLM responses
  • ✅ VCS Auto-Resolution: Automatically marks resolved conflicts in Git/Mercurial
  • 🎨 Collapsible Sections: Organized Jira comments with expand/collapse functionality
  • 🧪 Comprehensive Tests: 103+ tests ensuring bulletproof reliability
  • ⚡ Enhanced Context: Full file content sent to AI for better merge decisions
  • 🔄 Robust Error Handling: Multiple recovery options when AI responses fail

Installation

Basic Installation

gem install n2b

Global Installation with rbenv

For users with rbenv (Ruby version manager), install globally to make n2b available across all Ruby versions:

# Option 1: Install in system Ruby (Recommended)
rbenv global system
gem install n2b
rbenv rehash

# Option 2: Install in a dedicated Ruby version
rbenv install 3.3.0
rbenv global 3.3.0
gem install n2b
rbenv rehash

# Verify installation works across Ruby versions
rbenv shell 3.1.0 && n2b --version
rbenv shell 3.2.0 && n2b --version

Fix rbenv Shim Issues

If n2b-diff command is not found after installation:

# Remove corrupted shim and regenerate
rm ~/.rbenv/shims/.rbenv-shim
rm -rf ~/.rbenv/shims/*
rbenv rehash

# Verify both commands are available
which n2b
which n2b-diff

Configure as Default Merge Tool

Git Integration

Add to your ~/.gitconfig:

[merge]
    tool = n2b-diff

[mergetool "n2b-diff"]
    cmd = n2b-diff "$MERGED"
    trustExitCode = true
    keepBackup = false

Usage:

git merge feature-branch
# CONFLICT (content): Merge conflict in file.rb
git mergetool  # Uses n2b-diff automatically

Mercurial (hg) Integration

Add to your ~/.hgrc:

[ui]
merge = n2b-diff

[merge-tools]
n2b-diff.executable = n2b-diff
n2b-diff.args = $output
n2b-diff.premerge = keep
n2b-diff.priority = 100

Usage:

hg merge
# conflict in file.rb
# n2b-diff launches automatically

Quick Start

🔍 AI-Powered Code Review (using n2b-diff --analyze) (⚡ Beta - Try It Now!)

# Get instant AI analysis of your changes
n2b-diff --analyze

# Compare against main branch with requirements checking and custom message
n2b-diff --analyze --branch main --requirements specs.md -m "Check for API compatibility."

# Full workflow with Jira integration
n2b-diff --analyze --jira PROJ-123 --update

🎯 For Jira & GitHub Users (Code Analysis)

# Set up Jira/GitHub integration (done once via n2b's config)
n2b --advanced-config

# Analyze code changes against a Jira ticket
n2b-diff --analyze --jira PROJ-123 --update

# Analyze code changes against a GitHub issue
n2b-diff --analyze --github your-org/your-repo/issues/42 --update

💻 For Command Generation (using n2b)

# Generate bash commands
n2b "create a new git repo and push to github"

# Execute commands directly
n2b -x "backup all .rb files to backup folder"

Detailed Usage

In IRB/Rails Console

First, require and extend the N2B module:

require 'n2b'
extend N2B::IRB

For automatic loading in every IRB session, add these lines to your ~/.irbrc:

require 'n2b'
extend N2B::IRB

After loading, you can use the following commands:

  • n2r - For general Ruby assistance
  • n2rrbit - For Errbit error analysis
  • n2rscrum - For generating Scrum tickets

Examples

# Get help with a Ruby question
n2r "How do I parse JSON in Ruby?"

# Analyze an Errbit error
n2rrbit(url: "your_errbit_url", cookie: "your_cookie")

# Generate a Scrum ticket
n2rscrum "Create a user authentication system"

Configuration

N2B now features a flexible model configuration system that supports both suggested models and custom model names across all providers.

Quick Setup

Run the configuration command to get started:

n2b -c

This will guide you through:

  • Selecting your preferred LLM provider (Claude, OpenAI, Gemini, OpenRouter, Ollama)
  • Choosing from suggested models or entering custom model names
  • Setting up API keys
  • Configuring privacy settings

Supported Models

🤖 Claude (Default: sonnet)

  • haiku → claude-3-haiku-20240307
  • sonnet → claude-3-sonnet-20240229
  • sonnet35 → claude-3-5-sonnet-20240620
  • sonnet37 → claude-3-7-sonnet-20250219
  • sonnet40 → claude-sonnet-4-20250514
  • Custom models: Any Claude model name

🧠 OpenAI (Default: gpt-4o-mini)

  • gpt-4o → gpt-4o
  • gpt-4o-mini → gpt-4o-mini
  • o3 → o3 (Latest reasoning model)
  • o3-mini → o3-mini
  • o3-mini-high → o3-mini-high
  • o4 → o4
  • o4-mini → o4-mini
  • o4-mini-high → o4-mini-high
  • Custom models: Any OpenAI model name

🔮 Gemini (Default: gemini-2.5-flash)

  • gemini-2.5-flash → gemini-2.5-flash-preview-05-20
  • gemini-2.5-pro → gemini-2.5-pro-preview-05-06
  • Custom models: Any Gemini model name

🌐 OpenRouter (Default: deepseek-v3)

  • deepseek-v3 → deepseek-v3-0324
  • deepseek-r1-llama-8b → deepseek-r1-distill-llama-8b
  • llama-3.3-70b → llama-3.3-70b-instruct
  • llama-3.3-8b → llama-3.3-8b-instruct
  • wayfinder-large → wayfinder-large-70b-llama-3.3
  • Custom models: Any OpenRouter model name

🦙 Ollama (Default: llama3)

  • llama3 → llama3
  • mistral → mistral
  • codellama → codellama
  • qwen → qwen2.5
  • Custom models: Any locally available Ollama model

Custom Configuration File

You can use a custom config file by setting the N2B_CONFIG_FILE environment variable:

export N2B_CONFIG_FILE=/path/to/your/config.yml

You can also set the history file location using the N2B_HISTORY_FILE environment variable:

export N2B_HISTORY_FILE=/path/to/your/history

Debug Mode

For troubleshooting Jira integration or other issues, enable debug mode:

export N2B_DEBUG=true
n2b-diff --analyze --jira PROJ-123 --update

This will show detailed information about:

  • Template content generation
  • API request/response details
  • ADF structure for Jira comments
  • Error diagnostics

Custom Prompt Templates

N2B uses text templates for AI prompts. To override them, specify paths in your configuration:

templates:
  diff_system_prompt: /path/to/my_system_prompt.txt
  diff_json_instruction: /path/to/my_json_instruction.txt
  merge_conflict_prompt: /path/to/my_merge_prompt.txt

When these paths are not provided, the built-in templates located in lib/n2b/templates/ are used.

Available Templates:

  • diff_system_prompt.txt - Main diff analysis prompt
  • diff_json_instruction.txt - JSON formatting instructions for diff analysis
  • merge_conflict_prompt.txt - Merge conflict resolution prompt

Editor Configuration

N2B allows you to configure your preferred text editor or visual diff tool for use with the [e] (Edit) option during merge conflict resolution. This can be set up during the advanced configuration flow (run n2b --advanced-config or n2b -c and choose to configure advanced settings).

You will be prompted to choose from a list of auto-detected editors (like nano, vim, code - VS Code) and diff tools (like meld, kdiff3, vimdiff). You can also provide a custom command.

The chosen editor is stored in your ~/.n2b/config.yml file under the editor key:

editor:
  command: "meld"
  type: "diff_tool" # Can be "text_editor" or "diff_tool"
  configured: true
  • If a text editor is configured, the [e] option will open the conflicted file directly for manual editing using the specified editor command.
  • If a diff tool is configured, N2B will prepare temporary files for the base, incoming, and current (LLM suggested) versions of the conflict and open them in your chosen 3-way merge tool. After you've used the tool, N2B will use the content from your successfully merged file.

Quick Example N2B

n2b init a new github repo called abc, add local files, transmit

results in

Translated /bin/zsh Commands:
------------------------
git init
git remote add origin https://github.com/yourusername/abc.git
git add .
git commit -m 'Initial commit'
git push -u origin main
------------------------
Explanation:
These commands initialize a new Git repository, add a remote GitHub repository named 'abc', stage all local files, create an initial commit, and push the changes to GitHub. Replace 'yourusername' with your actual GitHub username. Note that you'll need to create the repository on GitHub first before running these commands. Also, ensure you have Git installed and configured with your GitHub credentials.

Quick example n2r

irb
require 'n2b'
n2r 4544 # results in exception
n2r "what is the bug",exception:_

result

input_string.to_s.scan(/[\/\w.-]+\.rb(?=\s|:|$)/)

Explanation The error undefined method 'scan' for 7767:Integer occurs because the method scan is being called on an integer instead of a string. To fix the issue, we need to ensure that input_string is a string before calling the scan method on it. Here's the corrected part of the code that converts input_string to a string before using scan:

input_string.to_s.scan(/[\/\w.-]+\.rb(?=\s|:|$)/)

Installation

Install the gem by running: gem install n2b

Enhanced Model Selection

N2B v0.4.0 introduces a flexible model configuration system:

Interactive Model Selection

When you run n2b -c, you'll see an enhanced interface:

Choose a model for openai:
1. gpt-4o (gpt-4o)
2. gpt-4o-mini (gpt-4o-mini) [default]
3. o3 (o3)
4. o3-mini (o3-mini)
5. o3-mini-high (o3-mini-high)
6. o4 (o4)
7. o4-mini (o4-mini)
8. o4-mini-high (o4-mini-high)
9. custom (enter your own model name)

Enter choice (1-9) or model name [gpt-4o-mini]: 9
Enter custom model name: gpt-5-preview
✓ Using custom model: gpt-5-preview

Key Features

  • 🎯 Suggested Models: Curated list of latest models for each provider
  • 🔧 Custom Models: Enter any model name for fine-tunes, beta models, etc.
  • 🔄 Backward Compatible: Existing configurations continue working
  • 🚀 Latest Models: Access to newest OpenAI O-series, Gemini 2.5, etc.
  • ⚡ No Validation: Direct API model names accepted - let the API handle errors

Configuration is stored in ~/.n2b/config.yml.

Usage

Basic usage:

n2b [options] "your natural language instruction"

n2b Options:

  • -x, --execute: Execute the translated commands after confirmation.
  • -c, --config: Configure N2B (API key, model, privacy settings, etc.).
  • --advanced-config: Access advanced configuration options.
  • -v, --version: Show version information.
  • -h, --help: Display help information for n2b.

n2b-diff Command Usage:

n2b-diff [FILE] [options] (for merge conflicts) n2b-diff --analyze [options] (for code diff analysis)

n2b-diff Options: Merge Conflict Mode (when FILE is provided and not --analyze): - --context N: Number of context lines to display around a merge conflict. Diff Analysis Mode (--analyze): - -a, --analyze: Activate AI-powered diff analysis. - --branch [BRANCH_NAME]: Specify branch to compare against (e.g., 'main', 'develop'). Defaults to auto-detected primary branch. - -j, --jira JIRA_ID_OR_URL: Link a Jira ticket for context or updates. - --github GITHUB_ISSUE_URL: Link a GitHub issue for context or updates (e.g., 'owner/repo/issues/123'). - -r, --requirements FILE_PATH: Provide a requirements file for the AI. - -m, --message "TEXT": Add custom instructions for the AI analysis. - --update: If -j or --github is used, attempt to update the ticket/issue with the analysis (prompts for confirmation by default unless this flag is used for auto-yes). - --no-update: Prevent updating the ticket/issue. Common for n2b-diff: - -h, --help: Display help information for n2b-diff. - -v, --version: Show version information.

Other Commands:

  • n2b-test-jira: Test Jira API connection and permissions (functionality might be reviewed/updated).

Examples:

  1. Generate commands without executing:

n2b list all PDF files in the current directory

  1. Generate and execute commands:

n2b -x create a new directory named 'project' and initialize a git repository in it

  1. Reconfigure the tool:

n2b -c

🔍 AI-Powered Diff Analysis (using n2b-diff --analyze)

n2b-diff --analyze provides comprehensive AI-powered code review for your Git and Mercurial repositories.

Basic Diff Analysis

# Analyze uncommitted changes (against HEAD or default compare target)
n2b-diff --analyze

# Analyze changes against a specific branch
n2b-diff --analyze --branch main
n2b-diff --analyze --branch feature/auth

# Auto-detect default branch (main/master/default) if --branch is provided without a value
n2b-diff --analyze --branch

Requirements Compliance Checking & Custom Instructions

# Check if changes meet requirements from a file
n2b-diff --analyze --requirements requirements.md

# Combine with branch comparison and add a custom message for the AI
n2b-diff --analyze --branch main --requirements requirements.md -m "Pay special attention to the new UserProfile class."

What You Get

The AI analysis provides:

  • 📝 Summary: Clear overview of what changed
  • 🚨 Potential Errors: Bugs, security issues, logic problems with exact file/line references
  • 💡 Suggested Improvements: Code quality, performance, style recommendations
  • 🧪 Test Coverage Assessment: Evaluation of test completeness and quality
  • 📋 Requirements Evaluation: Compliance check with clear status indicators:
    • IMPLEMENTED: Requirement fully satisfied
    • ⚠️ PARTIALLY IMPLEMENTED: Needs more work
    • NOT IMPLEMENTED: Not addressed
    • 🔍 UNCLEAR: Cannot determine from diff

Example Output

Code Diff Analysis:
-------------------
Summary:
Added user authentication with JWT tokens and password validation.

Potential Errors:
- lib/auth.rb line 42: Password validation allows weak passwords
- controllers/auth_controller.rb lines 15-20: Missing rate limiting for login attempts

Suggested Improvements:
- lib/auth.rb line 30: Consider using bcrypt for password hashing
- spec/auth_spec.rb: Add tests for edge cases and security scenarios

Test Coverage Assessment:
Good: Basic authentication flow is tested. Missing: No tests for password validation edge cases, JWT expiration handling, or security attack scenarios.

Requirements Evaluation:
✅ IMPLEMENTED: User login/logout functionality fully working
⚠️ PARTIALLY IMPLEMENTED: Password strength requirements present but not comprehensive
❌ NOT IMPLEMENTED: Two-factor authentication not addressed in this diff
-------------------

Supported Version Control Systems

  • Git: Full support with auto-detection of main/master branches
  • Mercurial (hg): Full support with auto-detection of default branch

🎯 Jira & GitHub Integration (with n2b-diff --analyze)

n2b-diff --analyze provides seamless integration with Jira and GitHub for automated ticket/issue analysis and updates.

Setup

Configure Jira integration using the advanced configuration:

n2b --advanced-config

You'll need:

  • Jira Domain: Your Atlassian domain (e.g., company.atlassian.net)
  • Email: Your Jira account email
  • API Token: Generate from Atlassian Account Settings

Required Jira API Scopes

Your API token needs these specific scopes:

Essential Scopes:

  • read:project:jira - View projects (access project list)
  • read:issue:jira - View issues (fetch ticket details)
  • read:comment:jira - View comments (fetch ticket comments for context)
  • write:comment:jira - Create and update comments (post analysis results)

Optional but Recommended:

  • read:issue-details:jira - View detailed issue information
  • read:issue.property:jira - View issue properties (comprehensive ticket data)

Legacy Permission Names (for older Jira versions):

  • Browse Projects, Browse Issues, View Comments, Add Comments

Usage

# Analyze code changes against Jira ticket requirements
n2b-diff --analyze --jira PROJ-123

# Use full Jira URL
n2b-diff --analyze --jira https://company.atlassian.net/browse/PROJ-123

# Auto-update Jira ticket without prompt (if configured and supported by client)
n2b-diff --analyze --jira PROJ-123 --update

# Analyze only, do not offer to update Jira ticket
n2b-diff --analyze --jira PROJ-123 --no-update

# Analyze code changes against GitHub issue, with custom message and update
n2b-diff --analyze --github your-org/your-repo/issues/42 -m "Focus on UI changes" --update

What It Does

  1. Fetches Ticket Details: Downloads ticket description and comments
  2. Extracts Requirements: Automatically identifies requirements, acceptance criteria, and tasks
  3. Analyzes Code Changes: Compares your diff against ticket requirements
  4. Updates Ticket: Posts structured analysis comment with:
    • Implementation summary (what you accomplished)
    • Technical analysis findings
    • Potential issues and suggestions
    • Test coverage assessment
    • Requirements compliance check

Example Jira Comment

*N2B Code Analysis Report*
=========================

*Implementation Summary:*
Implemented user authentication with JWT tokens, password validation,
and session management as specified in the ticket requirements.

---

*Automated Analysis Findings:*

*Technical Changes:*
Added authentication middleware, JWT token generation, and password
hashing with bcrypt. Updated user model with authentication methods.

*Potential Issues/Risks:*
• No rate limiting on login attempts
• Password validation could be stronger

*Suggested Improvements:*
• Add rate limiting middleware
• Implement password strength requirements
• Add two-factor authentication support

*Test Coverage Assessment:*
Good: Basic authentication flow tested. Missing: Edge cases, security
scenarios, and JWT expiration handling tests.

*Requirements Evaluation:*
✅ IMPLEMENTED: User login/logout functionality
✅ IMPLEMENTED: Password hashing and validation
⚠️ PARTIALLY IMPLEMENTED: Session management (basic implementation)
❌ NOT IMPLEMENTED: Two-factor authentication

Testing Jira Connection

Test your Jira API connection and permissions:

# Test basic connection
n2b-test-jira

# Test specific ticket access
n2b-test-jira PROJ-123

This will verify:

  • Network connectivity to Jira
  • Authentication with your API token
  • Required permissions
  • Specific ticket access (if provided)

🔧 AI-Powered Merge Conflict Resolution (n2b-diff)

Resolve Git and Mercurial merge conflicts with intelligent AI assistance.

Quick Start

# Resolve conflicts in a file
n2b-diff conflicted_file.rb

# With more context lines
n2b-diff conflicted_file.rb --context 20

# Get help
n2b-diff --help

How It Works

  1. 🔍 Detects Conflicts: Automatically finds <<<<<<<, =======, >>>>>>> markers
  2. 📋 Extracts Context: Shows surrounding code for better understanding
  3. 🤖 AI Analysis: LLM analyzes both sides and suggests optimal merge
  4. 🎨 Interactive Review: Colorized display with Accept/Skip/Comment/Abort options
  5. ✅ Applies Changes: Updates file with accepted merges

Interactive Workflow

For each conflict, you can:

  • [y] Accept - Apply the AI suggestion
  • [n] Skip - Keep the conflict as-is
  • [c] Comment - Add context to improve AI suggestions
  • [s] Refresh Preview - Regenerate the HTML preview with the latest suggestion
  • [a] Abort - Stop processing and keep file unchanged

Features

🌐 3-Way HTML Conflict Preview

When resolving merge conflicts with n2b-diff, N2B now automatically generates a 3-way HTML preview of the conflict.

  • Automatic Opening: The preview is automatically opened in your default web browser.
  • Terminal Link: A clickable file:/// link to the preview is also displayed in your terminal.
    🌐 Opening conflict preview in browser...
    📁 Preview: file:///Users/user/.n2b_merge_log/conflict_preview_your_file.rb_20231027_103045.html
    
    Actions: [y] Accept, [n] Skip, [c] Comment, [e] Edit, [s] Refresh Preview, [a] Abort
    (Preview link above can be cmd/ctrl+clicked if your terminal supports it)
    Your choice:
    
  • Layout: The preview features a three-column layout:
    • Base Branch: Content from the base branch (e.g., HEAD).
    • Incoming Branch: Content from the incoming branch (e.g., your feature branch).
    • Current Resolution: The current LLM suggestion or your edited version, showing how the conflict would be resolved.
  • Full File View: Each column displays the entire file content, with the specific conflicting lines highlighted within their context. This allows for a comprehensive understanding of the changes.
  • Syntax Highlighting: Code is professionally syntax-highlighted using Highlight.js for improved readability across various programming languages.
  • Dynamic Updates: The preview is regenerated and reopened if the LLM suggestion changes (e.g., after you add a comment or use the [e] edit option and a new suggestion is fetched) or if you use the [s] (Refresh Preview) option.
  • Temporary Files: Preview files are stored temporarily in the .n2b_merge_log/ directory and are automatically cleaned up after the conflict is resolved or skipped for that particular block.

🎨 Colorized Display

  • 🔴 Red: Base/HEAD content (<<<<<<< HEAD)
  • 🟢 Green: Incoming content (>>>>>>> feature)
  • 🟡 Yellow: Conflict markers (=======)
  • 🔵 Blue: AI suggestions
  • Gray: Reasoning explanations

🤖 Smart AI Analysis

  • Context Awareness: Understands surrounding code patterns
  • Quality Decisions: Chooses enhanced implementations over simple ones
  • Consistency: Maintains coding patterns and architectural decisions
  • User Feedback: Incorporates comments to improve suggestions

⚙️ Configurable Options

  • Context Lines: --context N (default: 10)
  • Merge Logging: Optional JSON logs in .n2b_merge_log/
  • Custom Templates: Configurable merge prompts

Example Session

$ n2b-diff user_service.rb

<<<<<<< HEAD
def create_user(name, email)
  # Basic validation
  raise "Invalid" if name.empty?
  User.create(name: name, email: email)
end
=======
def create_user(name, email, age = nil)
  # Enhanced validation
  validate_name(name)
  validate_email(email)
  User.create(name: name.titleize, email: email.downcase, age: age)
end
>>>>>>> feature/enhanced-validation

--- Suggestion ---
def create_user(name, email, age = nil)
  # Enhanced validation with fallback
  validate_name(name) if respond_to?(:validate_name)
  validate_email(email) if respond_to?(:validate_email)
  User.create(name: name.titleize, email: email.downcase, age: age)
end

Reason: Combined enhanced validation from feature branch with safety checks
for method existence, maintaining backward compatibility while adding new features.

Accept [y], Skip [n], Comment [c], Abort [a]: y

Custom Templates

Customize merge prompts by adding to your config:

templates:
  merge_conflict_prompt: /path/to/my_merge_prompt.txt

Template variables available:

  • {full_file_content} - Complete file content for full context understanding
  • {context_before} - Code before the conflict
  • {context_after} - Code after the conflict
  • {base_label} - Base branch label (e.g., "HEAD")
  • {base_content} - Base branch content
  • {incoming_label} - Incoming branch label (e.g., "feature/auth")
  • {incoming_content} - Incoming branch content
  • {user_comment} - User-provided comment (if any)

Use Cases

  • Feature Branch Merges: Resolve conflicts when merging feature branches
  • Code Reviews: Get AI assistance for complex merge decisions
  • Refactoring: Handle conflicts during large refactoring efforts
  • Team Collaboration: Standardize merge conflict resolution approaches
  • Learning Tool: Understand best practices for conflict resolution

Daily Workflow Integration

Git Workflow

# During merge conflicts
git merge feature-branch
# CONFLICT (content): Merge conflict in file.rb

# Use configured merge tool
git mergetool

# Or call directly
n2b-diff file.rb

# Continue merge
git add file.rb
git commit -m "Resolve merge conflicts"

Mercurial Workflow

# During hg merge conflicts
hg merge
# conflict in file.rb

# Resolve with n2b-diff (auto-launches if configured)
n2b-diff file.rb

# Mark as resolved and commit
hg resolve --mark file.rb
hg commit -m "Resolve merge conflicts"

Rebase Conflicts

# Git rebase conflicts
git rebase -i main
# CONFLICT: Merge conflict in user_service.rb

n2b-diff user_service.rb
git add user_service.rb
git rebase --continue

Batch Conflict Resolution

# Find and resolve all conflicts
find . -name "*.rb" -exec grep -l "<<<<<<< HEAD" {} \; | while read file; do
    echo "Resolving conflicts in $file"
    n2b-diff "$file"
done

Shell Aliases for Convenience

Add to your .zshrc or .bashrc:

# Quick aliases for n2b tools
alias resolve-conflicts='n2b-diff' # For merge conflicts
alias test-jira='n2b-test-jira'   # For testing Jira connection
alias ai-diff='n2b-diff --analyze' # For AI diff analysis

# Function to resolve all conflict files
resolve-all-conflicts() {
    find . -name "*.rb" -exec grep -l "<<<<<<< HEAD" {} \; | while read file; do
        echo "Resolving conflicts in $file"
        n2b-diff "$file"
    done
}

n2r in ruby or rails console n2r "your question", files:['file1.rb', 'file2.rb'], exception: AnError only question is mandatory

N2B::IRB.n2r if no shortcut defined

Shortcut in rails console

create an initializer

# config/initializers/n2r.rb
require 'n2b/irb' 
Rails.application.config.after_initialize do

  Object.include(Module.new do
    def n2r(input_string = '', files: [], exception: nil, log: false)
      N2B::IRB.n2r(input_string, files: files, exception: exception, log: log)
    end
  end)

end

How It Works

  1. N2B takes your natural language input and sends it to the Claude AI API.
  2. The AI generates appropriate shell commands based on your input and configured shell.
  3. N2B displays the generated commands and explanations (if any).
  4. If the execute option is used, N2B will prompt for confirmation before running the commands.
  5. Optionally, commands are added to your shell history for future reference.

Privacy

N2B allows you to configure what information is sent to the Claude API:

  • Shell history / probably not needed, I added the option to give the llm more context
  • Past n2b requests and responses / probably not needed, I added the option to give the llm more context
  • Current working directory / recommended

You can adjust these settings during configuration.

Always sent to llm

  • prompt
  • shell type
  • operating system

Limitations

  • The quality of generated commands depends on the Claude AI model's capabilities.
  • Complex or ambiguous instructions might not always produce the desired results.
  • Always review generated commands before execution, especially when using the -x option.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.

Version History

v2.0.0 (Planned) - Command Restructure & Enhanced Diff Analysis

  • Command Restructuring: n2b is now for natural language to shell command translation only. n2b-diff handles merge conflicts and all AI-powered diff/code analysis. See MIGRATION.md.
  • Enhanced n2b-diff --analyze:
    • Added --github option for GitHub Issue integration (fetching details, updating issues).
    • Added -m, --message, --msg option for providing custom instructions to the AI during diff analysis.
    • Streamlined Jira integration options (--jira, --update, --no-update).
    • Diff analysis features (branch comparison, requirements files) now exclusively under n2b-diff --analyze.
  • Documentation Overhaul: Updated README, help texts, and added MIGRATION.md.
  • Test Suite Updates: Refactored tests for n2b and significantly enhanced tests for n2b-diff.
  • Internal Refinements: Created N2B::MessageUtils for message handling.

🔧 v0.7.2 - GitHub Integration & Enhanced AI Diff Analysis (as n2b --diff) (Pre-Restructure)

  • 🔗 GitHub Integration: Full GitHub issue support with fetch and comment functionality
  • 🔍 Enhanced AI Diff Analysis: Comprehensive code review with context-aware insights (Beta)
  • ☐ Interactive Jira Checklists: Native checkboxes for team collaboration and progress tracking
  • 🎯 Full Template Engine: Variables, loops, conditionals for maximum customization
  • 🚨 Smart Error Classification: Automatic severity detection (Critical/Important/Low)
  • 📁 Editor Integration: Open conflicted files in your preferred editor with change detection
  • 🛡️ JSON Auto-Repair: Automatically fixes malformed LLM responses
  • ✅ VCS Auto-Resolution: Automatically marks resolved conflicts in Git/Mercurial
  • 🎨 Collapsible Sections: Organized Jira comments with expand/collapse functionality
  • 🧪 Comprehensive Tests: 103+ tests ensuring bulletproof reliability
  • ⚡ Enhanced Context: Full file content sent to AI for better merge decisions
  • 🔄 Robust Error Handling: Multiple recovery options when AI responses fail

🔧 v0.5.4 - AI-Powered Merge Conflict Resolver (Introducing n2b-diff)

  • NEW: n2b-diff command - Interactive AI-powered merge conflict resolution.
  • Colorized conflict display with Accept/Skip/Comment/Abort workflow.
  • Smart AI suggestions with detailed reasoning and user feedback integration.
  • Custom templates for merge prompts and configurable context lines.
  • Merge logging and Git/Mercurial support.

🚀 v0.5.0 - Jira Integration & Enhanced Analysis (as n2b --diff)

  • Full Jira API integration with real ticket fetching and comment posting.
  • Structured Jira comments using ADF with collapsible sections.
  • Smart requirements extraction from ticket descriptions and comments.
  • Built-in connection testing with n2b-test-jira utility.
  • Enhanced configuration validation and error handling.

🔧 v0.4.0 - Flexible Model Configuration

  • Multiple LLM providers: Claude, OpenAI, Gemini, OpenRouter, Ollama.
  • Custom model support for fine-tunes and beta releases.
  • Latest models: OpenAI O3/O4 series, Gemini 2.5, Claude Sonnet 4.0.
  • Backward compatible configuration system.

🔍 v0.3.0 - AI-Powered Diff Analysis (as n2b --diff)

  • Git/Mercurial diff analysis with context extraction.
  • Requirements compliance checking.
  • Test coverage assessment.
  • Branch comparison with auto-detection.

Support

If you encounter any issues or have questions, please file an issue on the GitHub repository.

Generate Scrum Tickets from Errors

Create well-formatted Scrum tickets from Errbit errors:

require 'n2b'

# Generate a Scrum ticket from an Errbit error
n2rscrum(
  url: "https://your-errbit-instance/apps/12345/problems/67890",
  cookie: "your_errbit_session_cookie",
  source_dir: "/path/to/your/app"   # Optional: source code directory
)

The generated tickets include:

  • Clear title and description
  • Technical details with error context
  • Request parameters analysis
  • Root cause analysis
  • Suggested fixes with code examples
  • Acceptance criteria
  • Story point estimate
  • Priority level
  • Reference to the original Errbit URL

About

natural language to bash commands

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages