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 >= 1.3
.
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.
Then edit workspaces/default/cli.conf.yaml
to set kong_admin_uri
and kong_admin_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 <command> <workspace>
Where <command>
is one of:
config
Output or change configuration of the portal on the given workspace.deploy
Deploy changes made locally under the given workspace upstream.disable
Disable the portal on the given workspace.enable
Enable the portal on the given workspace.fetch
Fetches content and themes from the given workspace.wipe
Deletes all content and themes from upstream workspace.
Where <workspace>
indicates the directory/workspace pairing you would like to operate on.
- Add
-W
or--watch
to make changes reactive. - Add
-P
or--preserve
to avoid deleting files upstream that you do not have locally. - Add
-D
or--disable-ssl-verification
to disable SSL verification and use self-signed certs. - Add
-I
or--ignore-specs
to ignore the '/specs' directory.
- Add
-K
or--keep-encode
to keep binary assets as base64 encoded strings locally. - Add
-D
or--disable-ssl-verification
to disable SSL verification and use self-signed certs. - Add
-I
or--ignore-specs
to ignore the '/specs' directory.
- Add
-D
or--disable-ssl-verification
to disable SSL verification and use self-signed certs. - Add
-I
or--ignore-specs
to ignore the '/specs' directory.
- Add
-D
or--disable-ssl-verification
to disable SSL verification and use self-signed certs.
In addition to kong_admin_uri
and kong_admin_token
, you can also add:
disable_ssl_verification: true
andignore_specs: true
Set the options in the CLI configuration file to always enable those settings on that Workspace instead of passing the option flags with every command.
You can override some config values set in cli.conf.yaml
via environment variables. For example, If you wanted to override the Kong Admin URL, you can run:
KONG_ADMIN_URL=http://new-admin-url.com portal deploy default
Environment variables are useful for scripting as well as temporarily overriding particular settings.
Available environment variables include:
KONG_ADMIN_URL
Kong Admin URL the CLI should target for uploading files.KONG_ADMIN_TOKEN
Kong Admin Token token used to authenticate with the Kong Admin API.
For problems directly related to the CLI, add an issue on GitHub.
For other issues, submit a support ticket.
Contributors