Commands | Pluckeye

Pluckeye commands are typed in a console window and can be used to control Pluckeye. They are different than Pluckeye rules.

If you are new to Pluckeye or you are looking just for the most commonly used commands, see Command line basics.

If you are unfamiliar with running commands in a console you should not need to do so often, as most actions can also be performed by clicking buttons in the Pluckeye browser extension. (If you have the browser extension installed, click on the Pluckeye button in the top right of your browser to get started.) If you do want to use commands, see Notation for exactly how to type them in.

To search this page by keyword, use Ctrl + F on Windows & Linux or Command + F on Mac.

+ (add)

Examples

To add an allow rule:

   pluck + allow wikipedia.org
   pluck + block image/

To enable the system feature:

   pluck + system

Description

Adds a rule to your configuration or enables a feature.

Usage: pluck + [rule]

- (minus)

Examples

To remove an allow rule:

   pluck - allow facebook.com

To remove a when rule:

   pluck - when 8-9 allow youtube.com

To disable the nhb feature:

   pluck - nhb

Description

Removes a rule from your configuration or disables a feature. For example, if you delete a block rule for a given site, Pluckeye reverts to the default setting of blocking images and video while allowing pages to otherwise load. (An exception to this rule occurs if you have changed the default `block image/`, `block video/`, or if you have conflicting rules already in place. For example, if you have allow google.com and block google.com, the block rule overrides the allow rule. If the block rule is deleted, the allow rule succeeds. If the allow rule is also deleted, the default rule succeeds and blocks images and video while allowing the site to otherwise load.)

If you attempt to remove a rule that is not in your configuration, this command does nothing.

Usage: pluck - [rule]

abort

Examples

In all of the following examples a rule change is entered, but the rule never comes into effect if you have a non-zero delay, because the change is aborted.

   pluck + allow wikipedia.org
   pluck abort
   pluck + allow https://example.com/foo
   pluck abort example.com
   pluck + allow example.com image/
   pluck abort image

Description

Aborts pending rule changes (those that will take effect once the delay has elapsed). By default all pending rule changes are removed. If a website, page, program, etc. is given, all pending changes that match that context are removed.

Usage: pluck abort [context]

approved?

Fetches expedite approvals from the users site. Currently it is necessary to run this after one of your supporters has approved one of your expedite requests, in order for the change to take effect on your device. Hopefully this will be automatic in the future.

Usage: pluck approved?

clear

Removes all Pluckeye rules, meaning you will have full Internet access after your delay elapses. It makes sense to run this once after you first install Pluckeye if you want Pluckeye to only block a few websites, and allow all access otherwise. There is no way to automatically go back to the configuration you had after running this. If you want to save your existing configuration so you can restore it later, you can use export to do this.

See also: allow everything

Usage: pluck clear

compact

A maintenance command to shrink data.

Usage: pluck compact

delay

Main article: Delay

delays

Prints the current delay, and also non-standard delays that apply to specific websites, pages, programs, etc.

Usage: pluck delays

eval

Examples

The output you see when you run this command will depend on your Pluckeye configuration; the default configuration produces outputs similar to the ones shown here.

Input (what you type):

   pluck eval google.com

Output (what the computer adds):

allow because of rule 330: allow

eval says google.com is allowed, but this does not mean that all content (like images) will be visible on the website. All it means is that you should be able to visit the page. In order to determine if images will be shown, we must add image/.

Input:

   pluck eval google.com image/

Output:

block because of rule 420: block image/

Description

Evaluates whether a given website, page, program, etc. is allowed according to your current configuration. It can be used to troubleshoot why something is or isn’t being displayed. Note that merely giving a website will tell you whether the website will load, not whether images or video on the website are allowed. (See the examples.)

By default, the command has an exit code of 0 unless an error occurs. If the -x flag is used, the command will have an exit code of 0 if the result was allow or null, and a non-zero exit code if it was block. (If you have no idea what this means, then you have no use for the -x flag.) This is mainly useful in scripts.

Usage: pluck eval [-x] <context>

export

Examples

All of these examples demonstrate how to create a file on your Desktop that contains your Pluckeye configuration.

Windows

    cd Desktop
    pluck export > pluckeye-configuration.txt

Linux or Mac OS

    cd ~/Desktop
    pluck export > pluckeye-configuration.txt

Description

Prints your Pluckeye configuration and any pending changes to it. (In technical terms, it prints all of the rules in your Pluckeye configuration and all pending rule changes to standard output.) You can also use it (as shown in the examples) to save your configuration in a file.

Usage: pluck export

factoryreset

Resets Pluckeye to its “factory” settings (i.e., as if you had just installed for the first time). Your current configuration will be lost. If you plan to reuse or restore your current configuration, make sure you export and save it to a configuration file before performing the factory reset.

Usage: pluck factoryreset

features

Prints enabled features, such as system and nhb.

Usage: pluck features

find

Examples

The output of this command will depend on your Pluckeye configuration; the default configuration produced the outputs shown here.

This example will give no output, since none of the rules in the default configuration contain “google.com”.

   pluck find google.com

Input:

   pluck find image/

Output:

allow image/svg+xml
block image/

Description

This feature was added to Pluckeye in versoin 1.0, so if you are using an older version of Pluckeye, this will not work for you.

Print rules in your configuration that match the given term(s). (In more technical terms, if any of the terms is a substring of a given rule, that rule is printed.)

Usage: pluck find <term(s)>

future

Prints all pending changes to your configuration.

Usage: pluck future

help

Prints usage and examples for basic Pluckeye commands. In v1.0.23 it reads:

Usage:

  pluck [--help|--more-help]
  pluck [add|del|+|-] <rule>
  pluck export

Examples:

  pluck + allow ok.com
  pluck + block http://no.com/something
  pluck - block um.com
  pluck export

See also: more-help

Usage: pluck --help or pluck help

import

Examples

Before running this command, first open the terminal in the directory (AKA folder) containing the pluckeye-configuration.txt file that you want to import.

   pluck import pluckeye-configuration.txt

Description

Overrides current configuration and imports a configuration file. The configuration file should contain a list of Pluckeye rules, with one rule per line. Lines starting with # will be ignored, so it can be used to add comments.

Usage: pluck import [configuration file]

import-allow

Examples

   pluck import-allow good-websites.txt

In good-websites.txt, there could be:

google.com
facebook.com
https://youtube.com/watch

Description

Similar to import, but the file should contain a list of websites, pages, programs, etc., and an `allow` rule will be added to your configuration for each one of these. This is equivalent to running pluck + allow [line] for every line in the context file, except that lines starting with # in the context file will be ignored.

Usage: pluck import-allow [context file]

import-block

Examples

   pluck import-block bad-websites.txt

Description

Similar to import-allow, but all of the websites, pages, programs, etc. in the context file will be blocked.

Usage: pluck import-block [context file]

mayprove

Synonym for approved?.

Usage: pluck mayprove

mety

Examples

   pluck mety .css

In this case, the output would be:

.css -> text/css

which tells you that the media type of CSS files is text/css.

See also: Media types

Description

Prints the media type for the specified extension.

Usage: pluck mety .<extension>

more-help

Prints usage and examples for many Pluckeye commands.

See also: help

Usage: pluck --more-help or pluck more-help

refresh

Refetches configurations from the users site. If you don’t know what this means, check out Synchronizing configurations.

See also: sync

Usage: pluck refresh

repair

Attempts to repair Internet access.

Usage: pluck repair

replace

Examples

This pipeline finds all rules in your configuration that contain “example.com”, replaces “allow” with “when now+5m block” in all of the rules, and then imports these new rules into your configuration. The point is to cause all content on example.com that was allowed by allow rules before to be blocked for the next five minutes.

   pluck find example.com | pluck replace allow "when now+5m block" | pluck import -

Description

This more technically advanced command reads standard input, replaces all instances of string0 with string 1, and prints the result on standard output. This is useful when pipelining.

Usage: pluck replace <string0> <string1>

supplicate

Sends expedite requests to the users site so that someone else can approve them.

Usage: pluck supplicate

sync

Synchronizes your device’s configuration with the one assigned to it on the users site. If you don’t know what this means, check out Synchronizing configurations.

See also: refresh

Usage: pluck sync

trim

A maintenance command to shrink data.

Usage: pluck trim

unimport

Similar to import, except that it removes all of the rules in the configuration file instead of adding them.

Usage: pluck unimport [configuration file]

unimport-allow

Similar to import-allow, except that it removes allow rules for each of the websites, pages, programs, etc. in the context file instead of adding them.

Usage: pluck unimport-allow [context file]

unimport-block

Similar to import-block, except that it removes block rules for each of the websites, pages, programs, etc. in the context file instead of adding them.

Usage: pluck unimport-block [context file]

uninstall

Uninstalls Pluckeye. The delay must be 0 before you do this.

Usage: pluck uninstall

upload

Upload your local configurations to the users site. See Synchronizing configurations for more info.

Usage: pluck upload

verdicts

Print recent Internet connection attempts and whether Pluckeye allowed or blocked them.

Usage: pluck verdicts

Understanding the output

The command will print many lines, each of which will have this form:

12:50:48.320 allow 1541 chromium google.com [2607:f8b0:400a:0806:0000:0000:0000:200e]:80 rule allow

This line tells us that at 12:50:48 the program named chromium attempted to connect to google.com, and Pluckeye allowed (allow) this connection.

This information can be useful when you want to allow or block a particular program, or a particular program’s access to a particular website.

version

Print the version of Pluckeye that is installed.

Usage: pluck version

Legacy

These commands are outdated, but were used in older versions of Pluckeye.

add

Replaced by + (add), which works the same way.

del

Replaced by - (minus), which works the same way.

level

Sets the level. Replaced by the system feature.

Usage: pluck level [new level]

rm

Replaced by - (minus), which works the same way.

set

Sets the delay. Replaced by delay.

Usage: pluck set “delay <new delay>”

unbork

Replaced by repair.