# writedocs-test

> **WriteDocs CLI** is a command-line tool designed to help you manage and run your WriteDocs development environment. It provides easy commands to start your development server, handle API integrations, and more.

Latest version **1.1.5** (published 2024-09-16) · 0 weekly downloads

## Install

```sh
npm install writedocs-test
pnpm add writedocs-test
yarn add writedocs-test
bun add writedocs-test
```

Provides the command `writedocs`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.5 |
| Published | 2024-09-16 |
| First published | 2024-09-16 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=18.0 |
| Dependencies | 2 |
| Unpacked size | 4.8 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | gabrielraeder |

## Links

- npm: https://www.npmjs.com/package/writedocs-test
- npm.io page: https://npm.io/package/writedocs-test

## Dependencies (2)

- [ora](https://npm.io/package/ora.md) ^8.1.0
- [writedocs-dependencies](https://npm.io/package/writedocs-dependencies.md) ^1.0.0

## Recent versions

- 1.1.5 (latest) — 2024-09-16

## README

# WriteDocs CLI

**WriteDocs CLI** is a command-line tool designed to help you manage and run your WriteDocs development environment. It provides easy commands to start your development server, handle API integrations, and more.

## Features

- **Start the WriteDocs development server** with ease.
- **Run API integration tasks** for your documentation projects.
- **User-friendly command-line interface** with helpful prompts and retry logic for common issues, like port conflicts.

## Installation

To install WriteDocs CLI globally, run:

```bash
npm install -g writedocs
```

This command installs the CLI tool globally on your system, making the `writedocs` command available from anywhere in your terminal.

## Usage

After installation, you can use the `writedocs` command followed by the appropriate sub-command to perform various tasks.

### Available Commands

- **`writedocs dev`**  
  Start the WriteDocs development server. This command handles port conflicts and retries automatically.

  ```bash
  writedocs dev
  ```

- **`writedocs api`**  
  Generates endpoint markdown pages from your OpenAPI Specification files.

  ```bash
  writedocs api
  ```

- **`writedocs help`**  
  Display help information, showing available commands and their descriptions.

  ```bash
  writedocs help
  ```

### Example

Starting the development server:

```bash
writedocs dev
```

If port 3000 is in use, the CLI will automatically try the next available port (e.g., 3001, 3002) until it finds an open port.

## Troubleshooting

### Port Conflicts

If you encounter issues with port conflicts (e.g., "Port 3000 is already in use"), the CLI will automatically try the next available port. If it exceeds the maximum number of retries, it will display an error message.

### Exceeding Retries

If the maximum number of retries is exceeded, check your system for conflicting services or manually specify a port by adjusting your environment variables.

---
_Source: https://npm.io/package/writedocs-test · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._