WingifyGuides

Tech Debt Client

The Wingify FE Tech Debt Client is a tool that analyzes your Wingify flags usage and provides recommendations based on the source code in your project. This application is configurable using command-line arguments.

#Features

  • Analyze Wingify flag usage in your codebase.
  • Provide recommendations for optimizing Wingify flags.

#Prerequisites

  • Go (if building from source): Install Go
  • Ensure you have your Wingify API Token and Account ID.

#Installation

#Building from source

  1. Clone the repository

    git clone <https://github.com/wingify/vwo-fme-tech-debt-client.git>
    cd vwo-fme-tech-debt-client
    
  2. Build the binary

    # Build the binary
    go build
    
    # Option 1: Using environment variables
    export_SOURCE_FOLDER=/path/to/source
    export WINGIFY_ACCOUNT_ID=123456
    export_API_TOKEN=abcd123
    export_REPO_BRANCH=main
    export_REPO_NAME=my-repo
    
    ./vwo-fme-tech-debt-client
    
    # Option 2: Using command line arguments
    ./vwo-fme-tech-debt-client \
      --sourceFolder=/path/to/source \
      --accountId=123456 \
      --apiToken=abcd123 \
      --repoBranch=main \
      --repoName=my-repo
    

#Usage

#Command-line arguments

The application accepts the following arguments:

Argument Description Required
--sourceFolder Path to the source folder Yes
--accountId Wingify Account ID Yes
--apiToken Wingify API Token Yes
--repoBranch Branch of the repository Yes
--repoName Name of the repository Yes


#Example Commands

#Basic Usage

Run the client with the required parameters:

./tech-debt-client --sourceFolder=/path/to/source --accountId=123456 --apiToken=abcd123 --repoBranch=main --repoName=my-repo

#Resources

Resource Link
GitHub https://github.com/wingify/vwo-fme-tech-debt-client/tree/master