Cuekit CLI

The official command-line interface for Cuekit.

The Cuekit CLI allows you to analyze your React Native projects, document navigation routes, and interact with the Cuekit platform.

Features

• Route Scanning: Automatically scan your React Native project to identify and document all navigation routes.
• AI-Powered Summaries: Use AI to generate summaries for routes that lack JSDoc comments.
• Multiple Output Formats: Output route documentation as a table, JSON, or Markdown file.
• Cuekit Integration: Upload analysis results directly to your Cuekit dashboard (requires configuration).

Installation

Install the Cuekit CLI globally using npm:

npm install -g cuekit-cli

Quick Start

To get started, run the scan command on your React Native project directory:

cuekit-cli scan ./my-react-native-project

This will analyze the project and output a table of all identified navigation routes.

For more advanced options, use the --help flag:

cuekit-cli scan --help

Configuration for Cuekit Dashboard

To upload your route analysis to the Cuekit dashboard, you need to create a configuration file in your project's root directory.

The CLI searches for one of the following files:

• cuekit.config.json
• cuekit.config.js
• cuekit.config.mjs
• cuekit.config.ts

Required Fields

• apiKey (string): Your Cuekit API key.
• appId (string): The App ID for your project.

Example (cuekit.config.json)

{
  "apiKey": "your-cuekit-api-key-here",
  "appId": "your-app-id-here"
}

Commands

• cuekit-cli scan PROJECTPATH

cuekit-cli help [COMMAND]

Display help for cuekit-cli.

USAGE
  $ cuekit-cli help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for cuekit-cli.

cuekit-cli scan PROJECTPATH

Scan a React Native project to document its navigation routes.

USAGE
  $ cuekit-cli scan PROJECTPATH [--ai] [-j | -o <value>]

ARGUMENTS
  PROJECTPATH  [default: .] The path to the React Native project directory.

FLAGS
  -j, --json         Output results as JSON.
  -o, --out=<value>  Output results as a Markdown file.
      --ai           Use AI for summarization when no JSDoc is found.

DESCRIPTION
  Scan a React Native project to document its navigation routes.

EXAMPLES
  $ cuekit-cli scan ./my-rn-project

  $ cuekit-cli scan ./my-expo-project --json

  $ cuekit-cli scan ./my-rn-project --out docs.md