Usage - Likhis

Command-Line Interface

Usage

likhis [options]

Options

Flag	Short	Description	Default
`--path`	`-p`	Path to project root directory	Current directory
`--output`	`-o`	Output format: `postman`, `insomnia`, `httpie`, `curl`	`postman`
`--file`	`-f`	Custom output file name	Auto-generated
`--output-path`	`-O`	Output directory path	Current directory
`--framework`	`-F`	Target framework: `auto` or plugin name	`auto`
`--full`		Generate exports for dev, staging, and prod	`false`

Basic Usage

Auto-Detect Framework

Point Likhis at any backend project and let it auto-detect the framework:

Terminal

likhis -p ./my-project -o postman

Specify Framework

Explicitly specify the framework for faster and more accurate detection:

Terminal

likhis -p ./express-app -o postman -F express
likhis -p ./flask-app -o insomnia -F flask
likhis -p ./spring-app -o httpie -F spring
likhis -p ./laravel-app -o curl -F laravel

Custom Output File

Specify a custom file name for the generated collection:

Terminal

likhis -p ./my-api -o postman -f custom-collection.json

Custom Output Directory

Write the output to a specific directory:

Terminal

likhis -p ./my-api -o postman --output-path ./exports

Custom Output Directory and File Name

Terminal

likhis -p ./my-api -o postman -f my-api -O ./exports
# Generates: ./exports/my-api.json

Advanced Usage

Environment-Specific Exports

Use the --full flag to generate separate collections for development, staging, and production environments. Each environment uses its own base URL.

Terminal

likhis -p ./my-api -o postman --full
# Generates:
#   postman-collection-dev.json
#   postman-collection-staging.json
#   postman-collection-prod.json

Environment Exports to Custom Directory

Terminal

likhis -p ./my-api -o postman --full --output-path ./api-exports
# Generates:
#   ./api-exports/postman-collection-dev.json
#   ./api-exports/postman-collection-staging.json
#   ./api-exports/postman-collection-prod.json

All Supported Output Formats

Format	Flag	Output File	Usage
Postman	`-o postman`	`postman-collection.json`	Import into Postman Desktop or web
Insomnia	`-o insomnia`	`insomnia-export.json`	Import into Insomnia Desktop
HTTPie Desktop	`-o httpie`	`httpie-collection.json`	Import into HTTPie Desktop
cURL	`-o curl`	`api-requests.sh`	Run directly as a shell script

Framework-Specific Examples

Express.js with Router Mounting

Terminal

likhis -p ./express-app/src -o postman -F express

Django URL Patterns

Terminal

likhis -p ./django-project -o insomnia -F django

Spring Boot Controllers

Terminal

likhis -p ./spring-app/src/main/java -o postman -F spring

Flask Blueprints

Terminal

likhis -p ./flask-app -o insomnia -F flask

Laravel API Routes

Terminal

likhis -p ./laravel-app -o curl -F laravel

Example Output

When you run Likhis on a project, it outputs information about what it found:

Terminal

$ likhis -p ./exp/express -o postman -F express

Scanning project at: /Users/user/projects/likhis/exp/express
Framework detection: express
Output format: postman
Loaded 1 plugin(s)
Found 3 files to analyze
Extracted 5 routes
Successfully generated postman-collection.json
You can now use this file with Postman

The generated postman-collection.json can be imported directly into Postman. It includes all discovered routes with proper HTTP methods, path parameters, query parameters, and request body templates.