Installation

This guide will help you get NudgeLang up and running on your system.

Prerequisites

Before installing NudgeLang, ensure you have the following:

  • Python 3.8 or higher
  • pip (Python package manager)
  • Git (optional, for version control)

Installation Methods

Using pip

The simplest way to install NudgeLang is using pip:

pip install nudgelang

From Source

To install from source:

  1. Clone the repository:
git clone https://github.com/nudgelang/nudgelang.git
cd nudgelang
  1. Install dependencies:
pip install -r requirements.txt
  1. Install NudgeLang:
pip install -e .

Verifying Installation

After installation, verify that NudgeLang is properly installed:

nudgelang --version

You should see the current version number displayed.

Configuration

NudgeLang requires minimal configuration to get started. The main configuration file is located at ~/.nudgelang/config.yaml. Here’s a basic configuration:

# NudgeLang Configuration
version: "1.0"

# Default model settings
models:
  default:
    type: "claude"
    version: "claude-3-7-sonnet"
    temperature: 0.7
    max_tokens: 1000

# MCP server settings
mcp_servers:
  default:
    endpoint: "https://api.example.com/mcp"
    auth:
      type: "bearer"
      token_env: "MCP_TOKEN"

# Logging configuration
logging:
  level: "info"
  file: "nudgelang.log"

Next Steps

Last updated on