All Projects → TykTechnologies → tyk-cli

TykTechnologies / tyk-cli

Licence: MPL-2.0 License
Tyk plugin bundler utility

Programming Languages

go
31211 projects - #10 most used programming language
shell
77523 projects

tyk-cli

Tyk CLI utility.

Build Status Coverage Status

Note: Starting on Tyk Gateway v2.8, the bundle command is included as part of the gateway binary so it's no longer required to install tyk-cli as a separate tool, see here for more details.

Install

go get -u github.com/TykTechnologies/tyk-cli

Available modules

Bundle

This module provides useful commands for working with custom middleware bundles. The most basic command is build:

Assuming you're on a directory that contains your required bundle files and a bundle manifest, you could run:

tyk-cli bundle build -output bundle-latest.zip

If no -output flag is present, the bundle will be stored as bundle.zip in the current working directory.

The bundle will contain a manifest.json with the computed checksum and signature.

By default, the bundles are signed, if no private key is specified, the program will prompt for a confirmation. If you need to force this behavior you may use the -y flag:

tyk-cli bundle build -output bundle-latest.zip -y

If you follow the standard behavior and need to sign your bundles, provide the path to your private key using the -key flag:

tyk-cli bundle build -output bundle-latest.zip -key mykey.pem

Docs

For more information about rich plugins, check the documentation here.

License

Tyk is released under the MPL v2.0 please see the LICENSE.md file for a full version of the license.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].