bloomreach/s4cmd

No list of commands in the --help output?

Open

#154 opened on May 22, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (210 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (1,394 stars)
PR merge metrics
 (PR metrics pending)

Description

Feels a bit silly but it seems like you missed the list of actual commands from the output you get when you run "s4cmd --help". It even misses in the one-line synopsis to tell you there is something else than just options needed:

$ s4cmd --help
Usage: s4cmd [options]

Super S3 command line tool. Version 2.1.0
[long list of options here]

I know the commands are listed on the web and I know s3cmd commands but if this tool is to be standing on its own legs and not just be "like s3cmd but with.." it should probably not assume so much familiarity with s3cmd as to skip the actual commands needed to put/del/sync files.

Contributor guide

Research direction
Add a list of available commands to the help output by modifying the argument parser's usage string or help text in the s4cmd source code.
Tech stack
python
Domain
cli
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
basic Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85