Skip to content

Commit

Permalink
Move configuration section up
Browse files Browse the repository at this point in the history
  • Loading branch information
robvanderleek committed Feb 3, 2024
1 parent e3dc574 commit 6cd60c3
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 6cd60c3

Please sign in to comment.