Estimated reading time:
This is the documentation for the Kong Enterprise 2.1.x beta.
To see the documentation for the latest stable version of Kong Enterprise, go to 1.5.x.
The Kong Developer Portal CLI is used to manage your Developer Portals from the
command line. It is built using clipanion.
This is the next generation TypeScript based Developer Portal CLI. The goal of
this project is to make a higher quality CLI tool over the initial sync script.
This project is built for Kong Enterprise
For Kong Enterprise
<= 0.36, or for
legacy mode on Kong Enterprise
>= 1.3 use the legacy sync script.
> npm install -g kong-portal-cli
The easiest way to start is by cloning the portal-templates repo master branch locally.
workspaces/default/cli.conf.yaml to set workspace
rbac_token to match your setup.
Make sure Kong is running and portal is on:
Now from root folder of the templates repo you can run:
portal [-h,--help] [--config PATH] [-v,--verbose] <command>
<command> is one of:
config Output or change configuration of the portal on the given
deploy Deploy changes made locally under the given workspace upstream.
disable Enable the portal on the given workspace.
enable Enable the portal on the given workspace.
fetch Fetches content and themes from the given workspace.
serve Run the portal of a given workspace locally.
wipe Deletes all content and themes from upstream workspace
--watch to make changes reactive