uapi-sdk/README.md

CLI client for Library Navigator API

# UAPI

A command-line interface for the Library Navigator API, allowing you to browse and search documentation libraries directly from your terminal.

## Installation

```bash
npm install -g uapi-sdk
```

Or use it directly with npx:

```bash
npx uapi-sdk
```

## Usage

### Check API Status

```bash
uapi status
```

### List Available Documentation Domains

```bash
uapi list
```

### Navigate a Directory

```bash
uapi nav /modal.com
```

With search suggestions:

```bash
uapi nav /modal.com -q installation
```

### View a File

```bash
uapi view /modal.com/README.md
```

### Search for Files

```bash
uapi search "deployment"
```

With library and result count:

```bash
uapi search "deployment" -l modal.com -k 10
```

### Configure the API URL

```bash
uapi config -u https://your-api-url.com
```

## Environment Variables

- `API_BASE_URL`: Set this environment variable to customize the Library Navigator API endpoint.

## Development

```bash
# Clone the repository
git clone <repository-url>
cd uapi-sdk

# Install dependencies
npm install

# Build the package
npm run build

# Run locally
node dist/index.js

# Watch for changes during development
npm run watch

# Publishing
npm version patch # Increments version number
npm publish       # Publishes to npm registry
```

## License

MIT