Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(README): add TOC #195

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 85 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,89 @@
# s4cmd
# s4cmd <!-- omit in toc -->
### Super S3 command line tool
[![Build Status](https://travis-ci.com/bloomreach/s4cmd.svg?branch=master)](https://travis-ci.com/bloomreach/s4cmd) [![Join the chat at https://gitter.im/bloomreach/ s4cmd](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/bloomreach/s4cmd?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://travis-ci.com/bloomreach/s4cmd.svg?branch=master)](https://travis-ci.com/bloomreach/s4cmd)
[![Gitter chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/bloomreach/s4cmd)

- [What's New in s4cmd 2.x](#whats-new-in-s4cmd-2x)
- [Motivation](#motivation)
- [Features](#features)
- [Installation and Setup](#installation-and-setup)
- [s4cmd Commands](#s4cmd-commands)
- [`s4cmd ls [path]`](#s4cmd-ls-path)
- [`s4cmd put [source] [target]`](#s4cmd-put-source-target)
- [`s4cmd get [source] [target]`](#s4cmd-get-source-target)
- [`s4cmd dsync [source dir] [target dir]`](#s4cmd-dsync-source-dir-target-dir)
- [`s4cmd sync [source] [target]`](#s4cmd-sync-source-target)
- [`s4cmd cp [source] [target]`](#s4cmd-cp-source-target)
- [`s4cmd mv [source] [target]`](#s4cmd-mv-source-target)
- [`s4cmd del [path]`](#s4cmd-del-path)
- [`s4cmd du [path]`](#s4cmd-du-path)
- [s4cmd Control Options](#s4cmd-control-options)
- [`-p S3CFG, --config=[filename]`](#-p-s3cfg---configfilename)
- [`-f, --force`](#-f---force)
- [`-r, --recursive`](#-r---recursive)
- [`-s, --sync-check`](#-s---sync-check)
- [`-n, --dry-run`](#-n---dry-run)
- [`-t RETRY, --retry=[integer]`](#-t-retry---retryinteger)
- [`--retry-delay=[integer]`](#--retry-delayinteger)
- [`-c NUM_THREADS, --num-threads=NUM_THREADS`](#-c-num_threads---num-threadsnum_threads)
- [`--endpoint-url`](#--endpoint-url)
- [`-d, --show-directory`](#-d---show-directory)
- [`--ignore-empty-source`](#--ignore-empty-source)
- [`--use-ssl`](#--use-ssl)
- [`--verbose`](#--verbose)
- [`--debug`](#--debug)
- [`--validate`](#--validate)
- [`-D, --delete-removed`](#-d---delete-removed)
- [`--multipart-split-size=[integer]`](#--multipart-split-sizeinteger)
- [`--max-singlepart-download-size=[integer]`](#--max-singlepart-download-sizeinteger)
- [`--max-singlepart-upload-size=[integer]`](#--max-singlepart-upload-sizeinteger)
- [`--max-singlepart-copy-size=[integer]`](#--max-singlepart-copy-sizeinteger)
- [`--batch-delete-size=[integer]`](#--batch-delete-sizeinteger)
- [`--last-modified-before=[datetime]`](#--last-modified-beforedatetime)
- [`--last-modified-after=[datetime]`](#--last-modified-afterdatetime)
- [S3 API Pass-through Options](#s3-api-pass-through-options)
- [`--API-ACL=[string]`](#--api-aclstring)
- [`--API-CacheControl=[string]`](#--api-cachecontrolstring)
- [`--API-ContentDisposition=[string]`](#--api-contentdispositionstring)
- [`--API-ContentEncoding=[string]`](#--api-contentencodingstring)
- [`--API-ContentLanguage=[string]`](#--api-contentlanguagestring)
- [`--API-ContentMD5=[string]`](#--api-contentmd5string)
- [`--API-ContentType=[string]`](#--api-contenttypestring)
- [`--API-CopySourceIfMatch=[string]`](#--api-copysourceifmatchstring)
- [`--API-CopySourceIfModifiedSince=[datetime]`](#--api-copysourceifmodifiedsincedatetime)
- [`--API-CopySourceIfNoneMatch=[string]`](#--api-copysourceifnonematchstring)
- [`--API-CopySourceIfUnmodifiedSince=[datetime]`](#--api-copysourceifunmodifiedsincedatetime)
- [`--API-CopySourceRange=[string]`](#--api-copysourcerangestring)
- [`--API-CopySourceSSECustomerAlgorithm=[string]`](#--api-copysourcessecustomeralgorithmstring)
- [`--API-CopySourceSSECustomerKeyMD5=[string]`](#--api-copysourcessecustomerkeymd5string)
- [`--API-CopySourceSSECustomerKey=[string]`](#--api-copysourcessecustomerkeystring)
- [`--API-ETag=[string]`](#--api-etagstring)
- [`--API-Expires=[datetime]`](#--api-expiresdatetime)
- [`--API-GrantFullControl=[string]`](#--api-grantfullcontrolstring)
- [`--API-GrantReadACP=[string]`](#--api-grantreadacpstring)
- [`--API-GrantRead=[string]`](#--api-grantreadstring)
- [`--API-GrantWriteACP=[string]`](#--api-grantwriteacpstring)
- [`--API-IfMatch=[string]`](#--api-ifmatchstring)
- [`--API-IfModifiedSince=[datetime]`](#--api-ifmodifiedsincedatetime)
- [`--API-IfNoneMatch=[string]`](#--api-ifnonematchstring)
- [`--API-IfUnmodifiedSince=[datetime]`](#--api-ifunmodifiedsincedatetime)
- [`--API-Metadata=[dict]`](#--api-metadatadict)
- [`--API-MetadataDirective=[string]`](#--api-metadatadirectivestring)
- [`--API-MFA=[string]`](#--api-mfastring)
- [`--API-RequestPayer=[string]`](#--api-requestpayerstring)
- [`--API-ServerSideEncryption=[string]`](#--api-serversideencryptionstring)
- [`--API-SSECustomerAlgorithm=[string]`](#--api-ssecustomeralgorithmstring)
- [`--API-SSECustomerKeyMD5=[string]`](#--api-ssecustomerkeymd5string)
- [`--API-SSECustomerKey=[string]`](#--api-ssecustomerkeystring)
- [`--API-SSEKMSKeyId=[string]`](#--api-ssekmskeyidstring)
- [`--API-StorageClass=[string]`](#--api-storageclassstring)
- [`--API-VersionId=[string]`](#--api-versionidstring)
- [`--API-WebsiteRedirectLocation=[string]`](#--api-websiteredirectlocationstring)
- [Debugging Tips](#debugging-tips)
- [Compatibility between s3cmd and s4cmd](#compatibility-between-s3cmd-and-s4cmd)
- [Additional technical notes](#additional-technical-notes)
- [Unimplemented features](#unimplemented-features)
- [Credits](#credits)

----

Expand Down