Skip to content

Commit

Permalink
Add documentation for command-line implementation (#1269)
Browse files Browse the repository at this point in the history
  • Loading branch information
hwh33 authored Dec 17, 2024
1 parent fc6a436 commit c4b1e43
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,17 @@ All these dependencies must be in your PATH. Some of this is Android specific, s
* `flutter pub get`
* `flutter run --flavor prod` or if you are using android studio use desktop configuration

#### As a Command-Line Application

A command-line implementation of Lantern is defined in the `cli` directory.

* `go build -o lantern-cli ./cli`
* `./lantern-cli <arguments>` (run with `-h` or `--help` to see available arguments)

You will likely want to specify the `-addr` argument (e.g. `-addr localhost:8080`) to define where the local proxy should be available.

If you want to point at a specific remote proxy, consult `hit_proxy.bash` for an example on how to set up a config directory with specific proxy config.

### Running on emulators

You can easily run emulators directly from the command line with the following:
Expand Down
2 changes: 2 additions & 0 deletions cli/cli.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
// Command cli provides a command-line implementation of the Lantern client. Run this command with
// -h or --help to see all available arguments.
package main

import (
Expand Down

0 comments on commit c4b1e43

Please sign in to comment.