Skip to content

Commit

Permalink
upd: Windows install command added. (#8)
Browse files Browse the repository at this point in the history
* upd: Readme updated.

* upd: Readme updated.

* upd: .gitignore & build command updated.

* upd: Resolve conversations.

* upd: Resolve conversations.

* upd: Readme updated.
  • Loading branch information
ramazansancar authored May 27, 2024
1 parent b69b372 commit dbd6aea
Show file tree
Hide file tree
Showing 2 changed files with 78 additions and 13 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Build file for the wedl project
*.exe
wedl
88 changes: 75 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,102 @@
# wedl

[![Test latest release](https://github.com/gnojus/wedl/actions/workflows/test.yml/badge.svg)](https://github.com/gnojus/wedl/actions/workflows/test.yml)

## Command line utility to download from wetransfer
## Command line utility to download from wetransfer

Easily download from wetransfer.com in the command line.

Uses unofficial wetransfer API used when downloading with a browser.

Written in Go.

## Usage
```

```bash
$ wedl --help
Usage:
wedl [options] <URL>

Options:
-h --help Show this screen.
-v --version Print version and exit.
-o FILE --output=FILE Output file. Use - for stdout.
-p PATH --path=PATH Downloaded files directory.
-s --silent Silent. Do not output anything to stderr.
-f --force Overwrite files if needed.
-i --info Write download info to stdout and exit.
-h --help Show this screen.
-v --version Print version and exit.
-o FILE --output=FILE Output file. Use - for stdout.
-p PATH --path=PATH Downloaded files directory.
-s --silent Silent. Do not output anything to stderr.
-f --force Overwrite files if needed.
-i --info Write download info to stdout and exit.
```
## Instaling
Download binaries from [releases](https://github.com/gnojus/wedl/releases).
Download binaries from [releases](https://github.com/gnojus/wedl/releases).
Or compile from source and install with the [Go toolchain](https://go.dev/dl/):
```
```bash
go install github.com/gnojus/wedl@latest
```
Or build from a writeable source tree:
```
### Linux and MacOS
Or compile from source:
```bash
git clone https://github.com/gnojus/wedl.git
cd wedl
go build
```
### Windows
Compile from source:
```sh
git clone https://github.com/gnojus/wedl.git
cd wedl

:: Build

:: Build executable
go build


:: Or Build with -output flag
go build -o wedl.exe wedl.go
```
## Run
### Linux and MacOS
```bash
./wedl --help
```
### Windows
Run the executable:
```sh
wedl.exe --help
```
### Usage examples
```sh
:: Help
go run . --help

:: Standart Download
go run . https://go.wetransfer.com/responsibility

:: Download to ./test/ directory
go run . -p=test https://we.tl/responsibility

:: Download to downloaded.zip
go run . -o=downloaded.zip https://we.tl/responsibility

:: Write download info to stdout
go run . -i https://we.tl/responsibility

```

0 comments on commit dbd6aea

Please sign in to comment.