KFParser CLI

A cross-platform command-line tool for parsing and visualizing project architectures

Prerequisites

  • Supported Operating Systems:
    • Windows 10 and later
    • macOS
    • Linux

Installation

Installation Steps

  1. Download the appropriate executable for your operating system
  2. (Optional) Add the kfparser directory to your system's PATH
  3. Verify installation by running: 
     ./kfclient-[os]-cli --version

Usage

Getting Help

  • General help:

    ./kfclient-[os]-cli --help

  • Analyze command help:

    ./kfclient-[os]-cli analyze --help

Analyze Command

Parse and visualize project architectures with comprehensive options.

./kfclient-[os]-cli analyze <directory_path> [options]

Required Options

OptionDescriptionRequired
--email <email>KloudFarm account emailYes
--password <password>KloudFarm account passwordYes
--project-id <id>Project identifierYes

Advanced Options

OptionDescriptionDefault
--parser <type>Specify parser type (all, application, kubernetes)all
--auto-upload, --no-auto-upload>Automatically upload results--auto-upload
--view, --no-view>Display parsed results in CLI--no-view

Example Scenarios

  1. Comprehensive Project Analysis

     ./kfclient-[os]-cli analyze /path/to/project \
  --email user@example.com \
  --password pass123 \
  --project-id proj123 \
  --parser all

  2. Application Architecture Parsing

     ./kfclient-[os]-cli analyze /path/to/project \
  --email user@example.com \
  --password pass123 \
  --project-id proj123 \
  --parser application \
  --view

  3. Kubernetes Architecture without Upload

     ./kfclient-[os]-cli analyze /path/to/project \
  --email user@example.com \
  --password pass123 \
  --project-id proj123 \
  --parser kubernetes \
  --no-auto-upload

Output and Behavior

  • Console Display: Configurable with --view flag
  • Auto-Upload: Enabled by default, generates a visualization link on KloudFarm

Troubleshooting

Common Issues

IssuePossible CauseSolution
Authentication ErrorIncorrect credentialsVerify KloudFarm account details
Invalid Project IDAccess permissionsCheck project ID and permissions
Parser ErrorsIncompatible file/directory structureReview error messages
Network Upload IssuesInternet connectivityCheck connection and firewall
Executable Not FoundPATH configurationEnsure correct installation
Permission DeniedInsufficient file system rightsRun with elevated permissions