🚧 This is a Work in Progress and has not yet been deployed to NPM 🚧
$ npm install -g ably-cli
$ ably COMMAND
running command...
$ ably (--version)
ably-cli/0.0.0 darwin-arm64 node-v19.0.0
$ ably --help [COMMAND]
USAGE
$ ably COMMAND
...ably accessably access listably access setably apps createably apps listably help [COMMAND]ably pluginsably plugins:install PLUGIN...ably plugins:inspect PLUGIN...ably plugins:install PLUGIN...ably plugins:link PLUGINably plugins:uninstall PLUGIN...ably plugins:uninstall PLUGIN...ably plugins:uninstall PLUGIN...ably plugins update
Provides instructions for setting up access for the Ably CLI
USAGE
$ ably access [--debug] [--help]
FLAGS
--debug Enables debug logging for the CLI
--help Show CLI help.
DESCRIPTION
Provides instructions for setting up access for the Ably CLI
EXAMPLES
$ ably access
See code: dist/commands/access/index.ts
Ably CLI access control
USAGE
$ ably access list [--debug] [--help] [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Enables debug logging for the CLI
--filter=<value> filter property by partial string matching, ex: name=foo
--help Show CLI help.
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
Ably CLI access control
EXAMPLES
$ ably access list
Update the control key used by the Ably CLI
USAGE
$ ably access set --accountid <value> --accesstoken <value> [--debug] [--help]
FLAGS
--accesstoken=<value> (required) The Control API Access Token
--accountid=<value> (required) The Account ID
--debug Enables debug logging for the CLI
--help Show CLI help.
DESCRIPTION
Update the control key used by the Ably CLI
EXAMPLES
$ ably access set --accountid <value> --accesstoken <value>
Create an Ably Application
USAGE
$ ably apps create --name <value> [--debug] [--help] [--tlsonly] [--columns <value> | -x] [--sort <value>]
[--filter <value>] [--output csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Enables debug logging for the CLI
--filter=<value> filter property by partial string matching, ex: name=foo
--help Show CLI help.
--name=<value> (required) Name of the Ably app
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
--tlsonly Only use TLS connections
DESCRIPTION
Create an Ably Application
EXAMPLES
$ ably apps create --name <value> [--tlsonly <value>]
List the Ably Applications
USAGE
$ ably apps list [--debug] [--help] [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--debug Enables debug logging for the CLI
--filter=<value> filter property by partial string matching, ex: name=foo
--help Show CLI help.
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List the Ably Applications
EXAMPLES
$ ably apps list
Display help for ably.
USAGE
$ ably help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for ably.
See code: @oclif/plugin-help
List installed plugins.
USAGE
$ ably plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ ably plugins
See code: @oclif/plugin-plugins
Installs a plugin into the CLI.
USAGE
$ ably plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ ably plugins add
EXAMPLES
$ ably plugins:install myplugin
$ ably plugins:install https://github.com/someuser/someplugin
$ ably plugins:install someuser/someplugin
Displays installation properties of a plugin.
USAGE
$ ably plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ ably plugins:inspect myplugin
Installs a plugin into the CLI.
USAGE
$ ably plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ ably plugins add
EXAMPLES
$ ably plugins:install myplugin
$ ably plugins:install https://github.com/someuser/someplugin
$ ably plugins:install someuser/someplugin
Links a plugin into the CLI for development.
USAGE
$ ably plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ ably plugins:link myplugin
Removes a plugin from the CLI.
USAGE
$ ably plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ably plugins unlink
$ ably plugins remove
Removes a plugin from the CLI.
USAGE
$ ably plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ably plugins unlink
$ ably plugins remove
Removes a plugin from the CLI.
USAGE
$ ably plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ably plugins unlink
$ ably plugins remove
Update installed plugins.
USAGE
$ ably plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
// TODO
Node.JS
// TODO: Add step by step instructions for building & running locally.
Want to help contributing to this project? Have a look at our contributing guide!
- Update the description of this repo.
- Add topics to this repo to clarify the language, tech stack and use case.
Update the .gitignore file with one of the standard templates from GitHub.- Update dependabot.yml with the configuration for your project.
Replacehttps://github.com/ably-labs/ably-labs-template-repo/issueswith the actual link of the repo in the CONTRIBUTING.md file.- Update this README so it provides enough information for people to understand how it works, how to run it locally and how it can be deployed to the cloud (see GitHub).
- Update the query string in the static asset link:
- For the logo at the bottom of this README and
- Please use a custom
faviconif you're creating a web app. The favicon should use the ably static asset endpoint<link rel="icon" type="image/svg+xml" href="https://static.ably.dev/motif-red.svg?lorem-ipsum" />and ensure this uses the same unique identifier as the Ably logo on the README. - More info in this repo.
- Add a GitHub workflow to build/test/deploy your application. Use the Ably Control API GitHub action to avoid creating Ably apps/API keys manually (see the
create-infra.ymlworkflow in this repo). - Add this repository to the selected repositories in the Ably Labs org that are allowed to run GitHub Actions.
