-
-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e3dc574
commit 6cd60c3
Showing
1 changed file
with
19 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -92,19 +92,16 @@ See respective lines in `docker-compose.yml` | |
- ~/.local/share/mudslide:/usr/src/app/cache | ||
``` | ||
# Usage | ||
Available commands and options can be listed with `--help` flag: | ||
# Configuration | ||
```shell | ||
npx mudslide@latest --help | ||
``` | ||
By default WhatsApp credentials are cached in a folder located in the user's | ||
home directory. This folder is `.local/share/mudslide'` on Linux & macOS and | ||
`AppData\Local\mudslide\Data` on Windows. | ||
|
||
for most command it's necessary that you've authorized Mudslide to interact | ||
with the WhatsApp API on your behalf. This can be done by logging in as | ||
described below. | ||
A different location for the cache folder can be configured via the environment | ||
variable `MUDSLIDE_CACHE_FOLDER` or the `-c`/`--cache` options. | ||
|
||
### Running behind a proxy server | ||
## Running behind a proxy server | ||
|
||
When the global option `--proxy` is used, Mudslide will use the environment variables `HTTP_PROXY` and `HTTPS_PROXY` to | ||
proxy all requests. For example: | ||
|
@@ -115,6 +112,18 @@ export HTTPS_PROXY=http://USER:[email protected]:80 | |
npx mudslide@latest --proxy login | ||
``` | ||
|
||
# Usage | ||
|
||
Available commands and options can be listed with `--help` flag: | ||
|
||
```shell | ||
npx mudslide@latest --help | ||
``` | ||
|
||
for most command it's necessary that you've authorized Mudslide to interact | ||
with the WhatsApp API on your behalf. This can be done by logging in as | ||
described below. | ||
|
||
## Login | ||
|
||
To login you need to authorize Mudslide from another device that has WhatsApp | ||
|
@@ -298,15 +307,6 @@ To get the WhatsApp ID of the logged in user: | |
npx mudslide@latest me | ||
``` | ||
|
||
# Configuration | ||
|
||
By default WhatsApp credentials are cached in a folder located in the user's | ||
home directory. This folder is `.local/share/mudslide'` on Linux & macOS and | ||
`AppData\Local\mudslide\Data` on Windows. | ||
|
||
A different location for the cache folder can be configured via the environment | ||
variable `MUDSLIDE_CACHE_FOLDER` or the `-c`/`--cache` options. | ||
|
||
# Troubleshooting | ||
|
||
In case Mudslide does not give any output or does not behave as expected, try | ||
|