Skip to content

Latest commit

 

History

History
65 lines (43 loc) · 1.78 KB

README.md

File metadata and controls

65 lines (43 loc) · 1.78 KB
Raw

Interslavic CLI Toolkit

CI/CD npm version License: GNU GPL v3

The Interslavic CLI Toolkit is a command-line interface tool designed to synchronize the Interslavic language database between Google Sheets and a Git+XML repository. It provides various commands for managing synsets and performing operations on Google Spreadsheets.

Installation

npm install -g @interslavic/cli

or

yarn global add @interslavic/cli

Usage

isv [command] [options]

Available Commands:

  • synsets: Execute operations on synsets
  • spreadsheets: Execute operations on Google Spreadsheets
  • users: Edit the configuration file

For more detailed information on each command, use the --help option:

isv --help
isv synsets --help
isv spreadsheets --help
isv users --help

Development

This project uses Yarn workspaces and requires Node.js version 20.18.0 or higher.

To set up the development environment:

  1. Clone the repository
  2. Run yarn install
  3. Build the project with yarn build

Scripts

  • yarn build: Build the project
  • yarn start: Run the CLI
  • yarn lint: Run linter on all workspaces
  • yarn test: Run tests on all workspaces

Contributing

Please read our contributing guidelines and code of conduct before submitting pull requests or issues.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.