https://github.com/MontFerret/cli

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

cli ferret golang hacktoberfest hacktoberfest2021 scraping

Last synced: 9 days ago
JSON representation

Ferret CLI

• Host: GitHub
• URL: https://github.com/MontFerret/cli
• Owner: MontFerret
• License: apache-2.0
• Created: 2020-05-16T14:34:50.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-30T15:26:25.000Z (over 1 year ago)
• Last Synced: 2024-08-01T13:29:05.890Z (3 months ago)
• Topics: cli, ferret, golang, hacktoberfest, hacktoberfest2021, scraping
• Language: Go
• Homepage:
• Size: 6.96 MB
• Stars: 18
• Watchers: 3
• Forks: 5
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Ferret CLI



	

		

	

	

		

	

	

		

	

	

		

	

	

		

	









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