Skip to content

Commit

Permalink
docs: add share command documentation and navigation in mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
Kremilly committed Dec 12, 2024
1 parent 20096b8 commit 83d371f
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
45 changes: 45 additions & 0 deletions docs/share.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# DumpSync Command: Share

The dumpsync share command is used to share on PasteBin the dump or scan result file generated by the DumpSync tool.

```bash
dumpsync share -f <path_to_share_file> --privacy <public|unlisted|private>
```

### Command Breakdown

- **dumpsync**: This is the main command to invoke the DumpSync tool.
- **share**: This subcommand is used to share a dump or scan result file.

### Parameters

- **-f <path_to_share_file>**: Specifies the path to share the file.
- **--privacy <public|unlisted|private>** (Optional|Default: 'unlisted'): Sets the privacy level of the shared file. Options are public, unlisted, or private.

### Example

Share the file `located at path/to/payload.txt`:

```bash
dumpsync share -f path/to/file.txt --privacy public
```

### Privacy Levels

- **Public**: The shared file is visible to everyone.
- **Unlisted**: The shared file is not visible in the public list but can be accessed by anyone with the link.
- **Private**: The shared file is only visible to the user who created it.

### Get the API Key

To share files, you need to get an API key from PasteBin. You can get the API key by creating an account on PasteBin and generating an API key from the account settings. Click [here](https://pastebin.com/doc_api) to get the API key.

### Shareable Files

Formats supported for the report file are:

- SQL
- TXT
- CSV
- JSON
- HTML
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ nav:
- Import: import.md
- Transfer: transfer.md
- Scan XSS: scan.md
- Share: share.md
- Writing patterns: writing-patterns.md

markdown_extensions:
Expand Down

0 comments on commit 83d371f

Please sign in to comment.