Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/MontFerret/cli

Ferret CLI
https://github.com/MontFerret/cli

cli ferret golang hacktoberfest hacktoberfest2021 scraping

Last synced: about 2 months ago
JSON representation

Ferret CLI

Awesome Lists containing this project

README

        

# Ferret CLI



Go Report Status


Build Status


Discord Chat


Ferret release


Apache-2.0 License


lab

Documentation is available [at our website](https://www.montferret.dev/docs/introduction/).

## Installation

### Binary

You can download the latest binaries from [here](https://github.com/MontFerret/cli/releases).

### Source (Go >= 1.18)
```bash
go install github.com/MontFerret/cli/ferret@latest
```

### Shell
```shell
curl https://raw.githubusercontent.com/MontFerret/cli/master/install.sh | sh
```

## Quick start

### REPL

```bash
ferret exec
Welcome to Ferret REPL

Please use `exit` or `Ctrl-D` to exit this program.
```

### Script execution
```bash
ferret exec my-script.fql
```

### With browser

```bash
ferret exec --browser-open my-script.fql
```

#### As headless

```bash
ferret exec --browser-headless my-script.fql
```

### Query parameters

```bash
ferret exec -p 'foo:"bar"' -p 'qaz:"baz"' my-script.fql
```

### With remote runtime (worker)

```bash
ferret exec --runtime 'https://my-worker.com' my-script.fql
```

## Options

```bash
Usage:
ferret [flags]
ferret [command]

Available Commands:
browser Manage Ferret browsers
config Manage Ferret configs
exec Execute a FQL script or launch REPL
help Help about any command
selfupdate Update Ferret CLI
version Show the CLI version information

Flags:
-h, --help help for ferret
-l, --log-level string Set the logging level ("debug"|"info"|"warn"|"error"|"fatal") (default "info")

Use "ferret [command] --help" for more information about a command.

```

## Contributors