Autogenerate completions for CLI tools built with cement
Autogenerate Completions for CLI tools built with
Install the integration as a dependency using pip:
pip install cement_complete_fig
Choose one of the methods below to add the
subcommand to the top level of your CLI tool.
Method 1: Load as a Cement extension
This package provides a Cement
for convenience called
which can be loaded in any of the ways cited in the linked documentation.
Repeated here for convenience you can do one of the following:
- Add the extension to the
from cement import App class MyApp(App): class Meta: label = 'myapp' extensions = [ ..., 'cement_complete_fig.ext.ext_complete_fig' ]
- Manually load the extension before running your app:
from cement import App with App('myapp') as app: app.ext.load_extension('cement_complete_fig.ext.ext_complete_fig') app.run()
- Add the extension to your app configuration file (e.g.
[myapp] exensions = cement_complete_fig.ext.ext_complete_fig
Method 2: Bind the controller manually
You can also add the
GenerateFigSpecController manually as a handler to your
from cement import App from cement_complete_fig import GenerateFigSpecController class MyApp(App): class Meta: label = 'myapp' handlers = [ ..., GenerateFigSpecController ] with MyApp() as app: app.run()
Generating the spec file
Once you've added the integration you will have new subcommand nested under your base handler. When this subcommand is invoked it will print a Fig spec.
To save your completion spec skeleton to a file, run the following:
myapp generate-fig-spec > myapp.ts
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for cement_complete_fig-1.0.0.tar.gz
Hashes for cement_complete_fig-1.0.0-py3-none-any.whl