Skip to content
Extends click.Group to invoke a command without explicit subcommand name.
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Initial commit Nov 30, 2015
.travis.yml
LICENSE Happy new year! Jan 1, 2016
README.md Update package configuration Jun 13, 2019
click_default_group.py Bump version: 1.2.2 Sep 5, 2019
setup.cfg Update package configuration Jun 13, 2019
setup.py Provide README in PyPi package website Jun 23, 2019
test.py

README.md

Click Default Group

DefaultGroup is a sub class of click.Group. But it invokes a default subcommand instead of showing a help message when a subcommand is not passed.

Build Status Coverage Status

Usage

Define a default subcommand by default=NAME:

import click
from click_default_group import DefaultGroup

@click.group(cls=DefaultGroup, default='foo', default_if_no_args=True)
def cli():
    pass

@cli.command()
def foo():
    click.echo('foo')

@cli.command()
def bar():
    click.echo('bar')

Then you can invoke that without explicit subcommand name:

$ cli.py --help
Usage: cli.py [OPTIONS] COMMAND [ARGS]...

Options:
  --help    Show this message and exit.

Command:
  foo*
  bar

$ cli.py
foo
$ cli.py foo
foo
$ cli.py bar
bar

Compatibility

click-default-group is compatible with these Click versions:

  • Click-7.0
  • Click-6.x
  • Click-5.1
  • Click-5.0
  • Click-4.1
  • Click-4.0

See the latest build status at Travis CI.

Licensing

Written by Heungsub Lee, and distributed under the BSD 3-Clause license.

You can’t perform that action at this time.