Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
S
swh-core
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Antoine Lambert
swh-core
Commits
bca3dbfd
Commit
bca3dbfd
authored
6 months ago
by
David Douard
Browse files
Options
Downloads
Patches
Plain Diff
doc: Add a small paragraph to activate shell completion
parent
ea020224
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/cli.rst
+32
-0
32 additions, 0 deletions
docs/cli.rst
with
32 additions
and
0 deletions
docs/cli.rst
+
32
−
0
View file @
bca3dbfd
...
...
@@ -9,6 +9,38 @@ Shared command-line interface
.. click:: swh.core.cli:swh
:prog: swh
Shell Completion
----------------
You may activate the command line completion mechanism for your shell. The
`swh` tool is using the `click`_ package, so activating command completion is a
simple matter of:
.. tab-set::
.. tab-item:: Bash
Add this to your `.bashrc`
.. code-block:: bash
eval "$(_SWH_COMPLETE=bash_source swh)"
.. tab-item:: Zsh
Add this to your `.zshrc`
.. code-block:: zsh
eval "$(_SWH_COMPLETE=zsh_source swh)"
See `click documentation`_ for more details and options.
.. _`click`: https://click.palletsprojects.com
.. _`click documentation`: https://click.palletsprojects.com/en/8.1.x/shell-completion
Database initialization utilities
---------------------------------
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment