Skip to content
Snippets Groups Projects
Commit 565521e7 authored by Karl Fogel's avatar Karl Fogel
Browse files

Update documentation

parent 14241bbc
No related branches found
No related tags found
No related merge requests found
......@@ -3,7 +3,8 @@
"""gl-sak: GitLab Swiss Army Knife.
A general-purpose GitLab tool for batch access to and manipulation of
entities (issues, labels, milestones, etc) in a GitLab project.
entities -- such as issues, labels, milestones, etc -- in a GitLab
project. Right now all it does is emit issues as JSON, though.
Usage
......@@ -11,7 +12,11 @@ Usage
E.g.,
$ ./gl-sak --authn-token-file=./seekrit --gitlab=https://code.librehq.com --project foo/bar/myproj get-issues
[... JSON output ...]
$ ./gl-sak --authn-token-file=./seekrit --gitlab=https://code.librehq.com --project foo/bar/myproj get-issue 6
[... JSON output ...]
Run with '--help' to see subcommands and their arguments.
......@@ -36,7 +41,6 @@ leak via 'ps' listings, shell history, etc. Only you can decide
whether using '--authn-token' is a reasonable choice given the
security properties of your runtime environment; if you are in any
doubt, choose '--authn-token-file' instead.
"""
import argparse
......@@ -167,8 +171,9 @@ def main():
private_token=args.authn_token)
gl.auth()
## WARNING: Turning on debugging can cause credentials and other
## sensitive data to be printed on the console.
## Note: if you turn debugging on, it can cause credentials and
## other sensitive data to be printed to the console.
#
# gl.enable_debug()
# Instantiate specified project, if any.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment