cli-datacontract is a command-line interface for importing data contracts from different sources. It facilitates integration with Google BigQuery, providing options to import data contracts from remote locations or local files.

• cli-datacontract
  • Table of Contents
  • Summary
  • Prerequisites
  • Installation
    • Binaries via GitHub Releases
    • Script Installation
  • Usage
    • Common Flags:
    • Commands:
      • Examples
  • Development
  • Contributing
  • License

cli-datacontract provides a command-line tool for importing data contracts, allowing seamless integration with remote sources or files, particularly centered around BigQuery operations. This tool enhances manageability and consistency across data workflows.

Ensure you have the following:

• Git: For version control.
• Go language: Needed if building the tool from source.

1. Visit the GitHub Releases page.
2. Download the appropriate binary for your system.
3. Make the binary executable:

   chmod +x cli-datacontract

4. Move it to a directory within your PATH.

Use the installation script:

curl -sSfL https://raw.githubusercontent.com/merlindorin/cli-datacontract/master/install.sh | sh

The cli-datacontract can be used with various commands and flags:

Usage: datacontract <command> [flags]

• -h, --help: Show help information.
• -D, --development: Enable development mode with debug logging.
• -l, --level="info": Set the logging level (options: debug, info, warn, error, fatal).
• -c, --config=CONFIG-FLAG: Specify the path to a configuration file.

• version: Display version information.
• licence: Show the application's license.
• bigquery: Bigquery related commands.

# Import data contract from a remote BigQuery source.
cli-datacontract bigquery remote --bigquery-projectid=lorem-654 --bigquery-datasetid=ipsum-1234 --bigquery-tablename=foo

# Import data contract from a specified file.
cli-datacontract bigquery file schema.json

To contribute to the project:

1. Clone the repository:

   git clone https://github.com/merlindorin/cli-datacontract.git
   cd cli-datacontract

2. For building and running tests, utilize Go's built-in tools. Ensure you are working on a feature branch:

   git checkout -b feature/your-feature

3. Follow best practices for coding and testing.

• Fork this repository and clone your fork.
• Create a feature branch: git checkout -b feature/your-feature.
• Commit your changes: git commit -am 'Add a feature'.
• Push to the branch: git push origin feature/your-feature.
• Open a pull request for review.

This project is licensed under the MIT License. See LICENSE.md for more details.