Pluckeye

https://docs.pluckeye.net
Admin
Pluckeye is a content filtering and internet restriction tool designed to help users manage and...
Tokens:49,311
Snippets:685
Trust Score:7.9
Update:8 months ago
Show doc for...
Tokens:
Raw
### Example Pluckeye Installation Session on Ubuntu

Source: https://docs.pluckeye.net/how-to-install

This is an example of a complete terminal session demonstrating the installation of Pluckeye on an Ubuntu system. It mirrors the general installation steps, showing the user's commands and the system's responses, including the password prompt for sudo.

```bash
jon@theodore:~$ cd /tmp
jon@theodore:/tmp$ rm -f ./pluck*.install*
jon@theodore:/tmp$ for tarball in $HOME/Downloads/pluck*.tar*; do echo $tarball; done
/home/jon/Downloads/plucky-install.tar.gz
jon@theodore:/tmp$ tar xf $tarball
jon@theodore:/tmp$ sudo ./plucky-install
[sudo] password for jon:
jon@theodore:/tmp$ 

```

--------------------------------

### Install Brave Browser on Linux using APT

Source: https://docs.pluckeye.net/program-compatibility-on-linux

This snippet details the steps to install the Brave browser on Linux distributions that use the APT package manager. It involves adding the Brave repository and its GPG key, updating the package list, and then installing the browser. Ensure curl is installed before running these commands.

```bash
sudo apt install curl

sudo curl -fsSLo /usr/share/keyrings/brave-browser-archive-keyring.gpg https://brave-browser-apt-release.s3.brave.com/brave-browser-archive-keyring.gpg

echo "deb [signed-by=/usr/share/keyrings/brave-browser-archive-keyring.gpg] https://brave-browser-apt-release.s3.brave.com/ stable main" | sudo tee /etc/apt/sources.list.d/brave-browser-release.list

sudo apt update

sudo apt install brave-browser

```

--------------------------------

### Host Context Examples

Source: https://docs.pluckeye.net/rules

Examples demonstrating the use of the 'host' context in Plucky rules, including subdomains and top-level domains.

```plaintext
allow example.com
block bb.example.com
allow host edu
```

--------------------------------

### Program Context Examples

Source: https://docs.pluckeye.net/rules

Examples of using the 'program' context in Plucky rules to control access for specific executables or directories.

```plaintext
block program calc.exe
allow program C:\Program Files\Visual Studio\code.exe
block program C:\Program Files\Visual Studio\code.exe
allow program /bin/curl
```

--------------------------------

### Install Spotify Client on Linux using APT

Source: https://docs.pluckeye.net/program-compatibility-on-linux

This section provides commands to install the Spotify client on Linux systems using APT. It includes adding the Spotify repository GPG key, configuring the Spotify repository, updating the package index, and finally installing the spotify-client package. The curl utility is required for this process.

```bash
sudo apt install curl

curl -fsSL https://download.spotify.com/debian/pubkey_7A3A762FAFD4A51F.gpg | sudo gpg --dearmor --yes -o /usr/share/keyrings/spotify-keyring.gpg

echo "deb [signed-by=/usr/share/keyrings/spotify-keyring.gpg] http://repository.spotify.com stable non-free" | sudo tee /etc/apt/sources.list.d/spotify.list

sudo apt-get update

sudo apt-get install spotify-client

```

--------------------------------

### Combined Context Example

Source: https://docs.pluckeye.net/rules

An example demonstrating how to combine multiple contexts in Plucky rules for granular control over program access to destinations.

```plaintext
allow 10.10.0.0 program curl
allow github.com program curl
allow host edu program curl
allow user:peter host:live.com program:microsoft teams helper
```

--------------------------------

### Install Pluckeye on Linux

Source: https://docs.pluckeye.net/how-to-install

This snippet shows the terminal commands to install Pluckeye on a Linux system. It involves navigating to a temporary directory, cleaning up old files, identifying the installer tarball, extracting it, and running the installation script with sudo privileges. Ensure you have the correct tarball path in your Downloads folder.

```bash
cd /tmp
rm -f ./pluck*install*
for tarball in $HOME/Downloads/pluck*.tar*; do echo $tarball; done
tar xf $tarball
sudo ./plucky-install

```

--------------------------------

### Allow Rule Example

Source: https://docs.pluckeye.net/rules

An example of an 'allow' rule in Plucky, specifying a context to permit access.

```plaintext
allow example.com
```

--------------------------------

### Protocol Context Examples

Source: https://docs.pluckeye.net/rules

Examples of using the 'protocol' context in Plucky rules to block specific URL protocols.

```plaintext
block protocol wss
block protocol about
```

--------------------------------

### IPv6 Context Example

Source: https://docs.pluckeye.net/rules

An example of using an IPv6 address as a context in Plucky rules.

```plaintext
allow ::1
```

--------------------------------

### Port Context Example

Source: https://docs.pluckeye.net/rules

An example of using the 'port' context in Plucky rules to block or allow specific network ports.

```plaintext
block port 80
```

--------------------------------

### Allowing Pip Packages with Plucky

Source: https://docs.pluckeye.net/faq

To allow the installation of Python packages using pip, Plucky needs to permit access to the PyPI (Python Package Index) domains. This example shows how to allow 'pypi.org' and 'pythonhosted.org'.

```bash
pluck + allow pypi.org
pluck + allow pythonhosted.org
```

--------------------------------

### Install libcurl4 for Pluckeye on Debian-based Linux

Source: https://docs.pluckeye.net/how-to-install

This snippet provides commands to resolve Plucky download failures on Debian-based Linux distributions. It first installs the 'libcurl4' package, which is a common dependency for network operations, and then re-runs the Pluckeye installation script.

```bash
sudo apt-get install libcurl4
sudo ./plucky-install

```

--------------------------------

### Block Rule Example

Source: https://docs.pluckeye.net/rules

An example of a 'block' rule in Plucky, specifying a context to deny access.

```plaintext
block example.com
```

--------------------------------

### IPv4 Context Examples

Source: https://docs.pluckeye.net/rules

Examples of using IPv4 addresses as contexts in Plucky rules, including specific addresses and entire subnets.

```plaintext
allow 192.168.1.1
allow 192.168.1.0
allow 192.168.0.0
```

--------------------------------

### Setting Plucky Delay with Time Units

Source: https://docs.pluckeye.net/delay

Demonstrates setting the Plucky delay using a time unit (hours). This example shows how a delay is applied and how a configuration change (allowing a site) takes effect after the specified delay period, without altering the delay itself.

```bash
pluck + delay 1h
# ... later ...
# Peter, without changing his delay at all, simply clicks the Plucky button to allow https://en.wikipedia.org/wiki/Mona_Lisa .
# This change will not take effect until 3pm, one hour later.
```

--------------------------------

### Get Plucky Help

Source: https://docs.pluckeye.net/command-line-basics

Access command-line help for Plucky using 'pluck help' and 'pluck more-help'. These commands provide information on additional functionalities and options available.

```bash
pluck help
pluck more-help
```

--------------------------------

### Get More Plucky Help

Source: https://docs.pluckeye.net/faq

Retrieves additional help information and documentation for Plucky commands directly from the command line.

```bash
pluck more-help
```

--------------------------------

### Block Chrome Web Store Extension Installation

Source: https://docs.pluckeye.net/troubleshooting

This command blocks the installation of extensions from the Chrome Web Store. It's useful for preventing extensions like Adblock Plus from bypassing Pluckeye's content filtering.

```bash
pluck + block https://chrome.google.com/webstore
```

--------------------------------

### Rule Precedence Example: URL vs. Host

Source: https://docs.pluckeye.net/rules

Illustrates the difference in precedence between URL-specific rules and host-wide rules. It's advised to use either host rules or URL rules for a given host, not a mix.

```plaintext
block youtube.com
allow https://www.youtube.com/
```

--------------------------------

### Unblock Rule Example

Source: https://docs.pluckeye.net/rules

An example of an 'unblock' rule in Plucky, used to allow access to a specific context that was previously blocked.

```plaintext
block image/
block http://example.com/
unblock http://example.com/fine-page
```

--------------------------------

### MediaType Context Examples

Source: https://docs.pluckeye.net/rules

Examples of using the 'mediaType' context in Plucky rules to block or allow specific types of internet content.

```plaintext
block image/
allow image/svg
```

--------------------------------

### Rule Precedence Example: Program vs. URL

Source: https://docs.pluckeye.net/rules

Demonstrates that a program-specific rule can have higher precedence than a URL rule, allowing the program to access the specified URL.

```plaintext
allow program brave.exe
block https://www.youtube.com/
```

--------------------------------

### Rule Precedence Example: Domain vs. Subdomain

Source: https://docs.pluckeye.net/rules

Demonstrates how a more specific rule (subdomain) takes precedence over a less specific rule (domain). Avoid mixing rules for a domain and its subdomains unless intended.

```plaintext
block youtube.com
allow www.youtube.com
```

--------------------------------

### Synchronize Plucky Configuration

Source: https://docs.pluckeye.net/family

Initiates synchronization of Plucky configuration with a remote service (likely for backup or monitoring). This allows for tracking changes made to the settings.

```bash
pluck sync
```

--------------------------------

### Example of Undesirable Rule Combination (Pluckeye CLI)

Source: https://docs.pluckeye.net/how-to-allow-a-program

Illustrates a common pitfall where a broad program allow rule (`allow program brave.exe`) can override a more specific block rule (`block youtube.com`), leading to unintended access. This highlights the importance of rule priority.

```bash
pluck + block youtube.com
pluck + allow program brave.exe
```

--------------------------------

### Blot Rule Examples

Source: https://docs.pluckeye.net/rules

Examples of 'blot' rules in Plucky, used to block imagery on webpages containing specific words.

```plaintext
blot word pizza
blot word spaghetti sauce
```

--------------------------------

### Rule Precedence Example: Everything vs. URL

Source: https://docs.pluckeye.net/rules

Shows that an 'allow everything' rule has very high precedence and will generally override specific block rules for URLs.

```plaintext
allow everything
block https://www.youtube.com/
```

--------------------------------

### Rule Precedence Example: Specific URL vs. General URL

Source: https://docs.pluckeye.net/rules

Shows how a more specific URL rule (e.g., a particular path) can be overridden by a broader URL rule. This highlights the importance of rule order and specificity.

```plaintext
allow https://www.youtube.com/
block https://www.youtube.com/watch
```

--------------------------------

### Handle Installation Errors (Pluckeye)

Source: https://docs.pluckeye.net/release-notes

This code snippet illustrates an error encountered during the Pluckeye installation process on Linux, specifically related to lv2.c and uninstall.c. It's provided as context for a bug fix in a later version.

```bash
sudo ./pluckeye-linux-0.21.2.installer >/dev/null
sudo ./pluckeye-linux-0.21.2.installer
< pluckexe/install/linux/lv2.c:59: error 53
< pluckexe/install/linux/lv2.c:59: error 53
< pluckexe/install/uninstall.c:478: exiting
```

--------------------------------

### Plucky Rule Examples

Source: https://docs.pluckeye.net/rules

Demonstrates basic Plucky rules for blocking images, allowing specific domains and IP addresses, blocking others, and fleeing websites containing specific words.

```plaintext
block image/
allow example.com
allow 127.0.0.1
block facebook.com
flee word:pizza
```

--------------------------------

### Unallow Rule Example

Source: https://docs.pluckeye.net/rules

An example of an 'unallow' rule in Plucky, used to negate a previous 'allow' rule for a more specific context.

```plaintext
block image/
allow http://example.com/
unallow http://example.com/questionable-page
```

--------------------------------

### Unflee Rule Example

Source: https://docs.pluckeye.net/rules

An example of an 'unflee' rule in Plucky, used to allow access to a specific context that was previously subject to a 'flee' rule.

```plaintext
flee word pizza
unflee http://example.com/fine-page word pizza
```

--------------------------------

### Configure User-Specific Plucky Rules

Source: https://docs.pluckeye.net/family

Sets up granular Plucky rules for individual users, allowing or blocking access based on user accounts and specific programs. This allows for tailored internet access for each family member.

```bash
pluck + allow user:susan
pluck + block user:lucy
pluck + block user:edmund
pluck + allow program:teams.exe user:edmund
pluck + allow statics.teams.cdn.live.net program:msedgewebview2.exe user:edmund
pluck + allow teams.events.data.microsoft.com program:msedgewebview2.exe user:edmund
pluck + allow teams.live.com program:msedgewebview2.exe user:edmund
pluck + allow teams.microsoft.com program:msedgewebview2.exe user:edmund
```

--------------------------------

### Set Installation Level (Pluckeye)

Source: https://docs.pluckeye.net/release-notes

This command allows users to set the installation level for Pluckeye. It is particularly useful for upgraders on Linux who may need to manually set their level to '2'.

```bash
pluckui set "level 2"
```

--------------------------------

### Plucky Delay Pattern Matching Examples

Source: https://docs.pluckeye.net/delay

Illustrates various delay pattern matching behaviors in Plucky, including natural, loose, exact, and prefixed matching. It shows how anchor characters like '~', '^', and '$' affect matching. Note that delay patterns are not regular expressions.

```pluck
pluck delay 1h
pluck delay 45m "+ allow https://www.youtube.com/"                 ## delay new youtube videos by 45 minutes
pluck + allow https://www.youtube.com/watch?v=3dNGacak8Dc          ## delayed 45 minutes
pluck + allow https://www.youtube.com/watch?v=3dNGacak8Dc user:jon ## also delayed 45 minutes
pluck + allow youtube.com                                          ## delayed 1 hour
```

```pluck
pluck delay 45m "+ allow a.com"                                    ## probably bad
pluck delay 45m "+ allow https://a.com/"                           ## probably good
```

```pluck
pluck delay 30m "+ allow"            ## delay any new allowances by 30 minutes
pluck delay 10m "+ allow otherwise"  ## delay the allow otherwise rule by 40 minutes
pluck delay 10h "- block"            ## delay removal of any blocks by 10 hours
pluck delay 24h "+ allow everything" ## delay allowing of "everything" by 24 hours
```

--------------------------------

### Import Old Pluckeye Settings (Windows)

Source: https://docs.pluckeye.net/one-dot-zero

Imports previously exported Pluckeye settings from 'old-pluckeye-settings.txt' on the desktop into the new Plucky version. This command is for Windows.

```bash
cd %HOMEPATH%\Desktop
pluck import < old-pluckeye-settings.txt
```

--------------------------------

### Rule Precedence Example: User vs. URL

Source: https://docs.pluckeye.net/rules

Illustrates that a user-specific rule can override a general URL block rule for that particular user.

```plaintext
allow user jon
block https://www.youtube.com/
```

--------------------------------

### Use Unblock to Allow Media and Respect Flee Rules in Pluckeye

Source: https://docs.pluckeye.net/flee

This example illustrates using the 'unblock' command to allow specific media types on a website, ensuring that 'flee' rules are still respected for other content. This provides a nuanced approach to content filtering.

```bash
pluck + block image/           # block images by default
pluck + unblock example.com    # but do not block images on example.com
pluck + flee word pizza        # and still flee pizza on example.com
```

--------------------------------

### Unblot Rule Example

Source: https://docs.pluckeye.net/rules

An example of an 'unblot' rule in Plucky, used to prevent a specific context from being blotted, even if it matches a 'blot' rule.

```plaintext
blot word pizza
unblot http://example.com/fine-page word pizza
```

--------------------------------

### Pluckeye 'when' Modifier Examples

Source: https://docs.pluckeye.net/when

Demonstrates various uses of the 'when' modifier in Pluckeye for scheduling delays and blocking/unblocking websites. This includes daily, weekly, and specific time-based rules.

```pluckeye
pluck + delay 20m
pluck + when 16-24 delay 4h
pluck + when F0-24 delay 4h
pluck + block facebook.com
pluck + when M12-13 unblock facebook.com
```

--------------------------------

### Pluckeye: Selective Ignoring with 'unblock'

Source: https://docs.pluckeye.net/release-notes

Demonstrates the use of 'unblock' in Pluckeye to selectively ignore less specific rules. This example shows how to allow images on a specific domain ('a.com') while still blocking images generally.

```bash
pluck clear
pluck + block image/
pluck + unblock image/ a.com  # allow images on a.com
pluck + blot word pizza       # affects a.com
```

--------------------------------

### Flee Rule Examples

Source: https://docs.pluckeye.net/rules

Examples of 'flee' rules in Plucky, which are stronger than 'block' and can block hosts, URLs, or webpages containing specific words.

```plaintext
flee host obviouslybad.com
flee url https://example.com/obviously-bad
flee word pizza
flee word spaghetti sauce
```

--------------------------------

### Configure System Feature and Delay with Plucky

Source: https://docs.pluckeye.net/faq

Combine scheduling with system feature activation and a delay to enforce internet restrictions. This example sets up nightly blackouts and a 1-day delay.

```bash
pluck + when 0-6,21-24 system
pluck + when 0-6,21-24 delay 1d
```

--------------------------------

### Set Time-Based Blocking Rule in Plucky

Source: https://docs.pluckeye.net/family

Configures a Plucky rule that is active only during specific time intervals. This example blocks a user during nighttime hours.

```bash
pluck + when 0-10 block user:lucy
```

--------------------------------

### Apply Semi-Conservative Parent Configuration in Plucky

Source: https://docs.pluckeye.net/family

Imports a set of pre-defined configurations suitable for conservative parental control. This includes restrictions on downloading programs, extensions, and documents from unapproved sites.

```bash
pluck + semi-conservative
```

--------------------------------

### Enable System-Wide Blocking with Plucky

Source: https://docs.pluckeye.net/family

Enables Plucky to block specified programs, including web browsers like Edge. This is a foundational step for system-level filtering.

```bash
pluck + system
```

--------------------------------

### Plucky Uninstall Restriction with Delay

Source: https://docs.pluckeye.net/delay

Shows that Plucky cannot be uninstalled if a delay is active. The first example fails because of the delay, while the second succeeds after the delay is set to 0 and elapses.

```bash
pluck + delay 1
pluck uninstall
```

```bash
pluck + delay 0
sleep 30
pluck uninstall
```

--------------------------------

### Import Old Pluckeye Settings (macOS/Linux)

Source: https://docs.pluckeye.net/one-dot-zero

Imports previously exported Pluckeye settings from 'old-pluckeye-settings.txt' on the desktop into the new Plucky version. This command is for macOS and Linux.

```bash
cd Desktop
pluck import < old-pluckeye-settings.txt
```

--------------------------------

### Schedule YouTube Access

Source: https://docs.pluckeye.net/youtube

This command allows scheduling access to YouTube. The example provided restricts media access from YouTube to Mondays between 10 AM and 12 PM.

```bash
pluck + when M10-12 allow youtube.com
```

--------------------------------

### Simplify Command Syntax for Immediate Actions in Pluckeye

Source: https://docs.pluckeye.net/release-notes

This demonstrates a simplified command syntax for Pluckeye, removing the 'when' keyword for immediate actions like allowing a domain. It shows how to allow 'ok.com' immediately and after a specified delay.

```bash
pluck + when now+1m allow ok.com
pluck + now+1m allow ok.com       # ditto
```

--------------------------------

### Add Allow/Deny Rules for URLs and Resources in Pluckeye (Shell)

Source: https://docs.pluckeye.net/release-notes

Provides examples of adding specific 'Allow' and 'Deny' rules for URLs, including resource types like images and specific MIME types like 'image/png'. These rules enable fine-grained control over web content access.

```shell
pluck add "Allow http://a.com/a-resource"
pluck add "Allow http://a.com/b-resource image/"
pluck add "Allow http://a.com/c-resource image/png"
pluck add "Deny http://a.com/d-resource"
pluck add "Deny http://a.com/e-resource image/"
pluck add "Deny http://a.com/f-resource image/png"
```

--------------------------------

### Run Sysinspect on Linux

Source: https://docs.pluckeye.net/sysinspect

This snippet demonstrates how to run the Sysinspect tool on Linux. It covers changing the directory, moving the downloaded executable, granting execute permissions, and running the tool with sudo. The process might take up to 10 minutes.

```shell
cd
cd Desktop
mv ../Downloads/sysinspect-linux ./
chmod +x sysinspect-linux
sudo ./sysinspect-linux
```

--------------------------------

### Enable Safe Browsing Feature in Plucky

Source: https://docs.pluckeye.net/family

Enables the 'safe' feature in Plucky, which enforces safe browsing across all users. This can be overridden for specific users or time periods.

```bash
pluck + safe
```

--------------------------------

### Export Pluckeye Settings (macOS/Linux)

Source: https://docs.pluckeye.net/one-dot-zero

Exports current Pluckeye settings to a file named 'old-pluckeye-settings.txt' on the desktop and creates a backup. This command is for macOS and Linux systems.

```bash
cd Desktop
pluck export > old-pluckeye-settings.txt
cp old-pluckeye-settings.txt old-pluckeye-settings.bak
```

--------------------------------

### Expedite Delay Change

Source: https://docs.pluckeye.net/expedite

Demonstrates how to expedite a change to the delay setting. This involves expediting both the new delay value and the removal of the current delay. The example shows expediting a change to 90, then to 0, and then previewing the expedite requests.

```bash
pluck delay 90
pluck delay 0
pluck expedite -n

```

--------------------------------

### Report Bugs with Pluckeye

Source: https://docs.pluckeye.net/release-notes

These commands initiate the bug reporting feature in Pluckeye. 'pluck bug report' starts the process of collecting information for a bug report, while 'pluck bug help' provides guidance on how to use the feature effectively.

```bash
pluck bug report
pluck bug help
```

--------------------------------

### Pluckeye Command with Comments

Source: https://docs.pluckeye.net/notation

This snippet illustrates how comments are denoted in Pluckeye command-line usage. Comments start with a '#' character and are ignored by the computer. They are used for editorial annotations.

```bash
pluck delay 12m        # Do not type the # or anything after it
pluck delay 24m        # because it is is an editorial comment.
pluck delay 24m        # The computer will not understand it.
```

--------------------------------

### Decreasing Plucky Delay

Source: https://docs.pluckeye.net/delay

Explains that decreasing the delay also requires surviving the current delay period. This example shows setting the delay to 0 and then waiting for the previous delay to elapse before it reflects the change.

```bash
$ pluck + delay 0
$ pluck delay
30
$ sleep 30
$ pluck delay
0
```

--------------------------------

### Specify Delays for Unadmin with Plucky CLI

Source: https://docs.pluckeye.net/delay

This command enables setting delays for the 'unadmin' action. Similar to feature delays, a '^' or '$' prefix is necessary for the pattern to be effective. The example demonstrates a 24-hour delay for the 'unadmin' action applied to 'peter'.

```bash
pluck delay 24h "- ^unadmin:peter"
```

--------------------------------

### Remove User Blocking Rule in Plucky

Source: https://docs.pluckeye.net/family

Demonstrates how to remove a previously applied Plucky blocking rule for a specific user. This is useful for adjusting restrictions, but can be a security risk if not managed carefully.

```bash
pluck - block user:edmund
```

--------------------------------

### Add and Remove Plucky Rules

Source: https://docs.pluckeye.net/command-line-basics

Add or remove rules using the '+' or '-' prefix followed by the rule details. This allows granular control over website access and media types. Examples include allowing/blocking entire sites, specific pages, or media types like images.

```bash
pluck + allow ok.com
pluck - allow ok.com
pluck + allow https://example.com/something
pluck - allow https://example.com/something
pluck + block google.com
pluck + block https://facebook.com/bob
pluck + block example.com image/
pluck + block program:foo.exe
pluck + block program bar.exe
```

--------------------------------

### Immediate Plucky Configuration Changes (Delay 0)

Source: https://docs.pluckeye.net/delay

Demonstrates Plucky commands that take immediate effect when the delay is set to 0 (nil). This includes adding allowed sites, allowing all content, and uninstalling Plucky.

```bash
pluck + allow a.com
pluck + allow everything
pluck uninstall
```

--------------------------------

### Execute Command with Sudo

Source: https://docs.pluckeye.net/release-notes

Executes a command, in this case `wget http://google.com/`, with superuser privileges using `sudo`. This is typically used for operations that require elevated permissions, such as downloading files to system directories or modifying system configurations.

```bash
sudo wget http://google.com/
```

--------------------------------

### Repair Pluckeye Installation

Source: https://docs.pluckeye.net/features

Runs the repair command for Pluckeye, often used after enabling certain features like `okfirefox` on Windows. This command helps ensure that Pluckeye is functioning correctly after configuration changes.

```bash
pluck repair
```

--------------------------------

### Enable Miscellaneous Blocking (nhb) in Plucky

Source: https://docs.pluckeye.net/family

Activates the 'nhb' (no harmful browsing) feature in Plucky, which enables additional, miscellaneous blocking rules. This is recommended for enhancing security on child devices.

```bash
pluck + nhb
```

--------------------------------

### Define Time-Based Blocking Rules in Pluckeye

Source: https://docs.pluckeye.net/release-notes

This syntax allows for flexible time-based blocking rules in Pluckeye. It enables specifying durations and conditions for blocking specific websites or content. The example shows blocking youtube.com between 3-4 and 5-6.

```bash
pluck + when 3-4,5-6 block youtube.com
```

--------------------------------

### Restrict Plucky Configuration Changes

Source: https://docs.pluckeye.net/family

Makes the device restricted, allowing only specific users (e.g., an administrator) to change Plucky configurations. This prevents unauthorized modifications to filtering rules.

```bash
pluck restricted
```

--------------------------------

### Add Temporary Allow Rules with 'now' Syntax

Source: https://docs.pluckeye.net/release-notes

These commands demonstrate how to add temporary rules to allow access to specific websites or URLs for a limited duration using the 'now' syntax. This is useful for granting temporary access without permanently altering the blocklist.

```bash
pluck add "onetime now+1h allow a.com"
pluck add "onetime now+1h allow https://a.com/blah"
pluck add "onetime M12-14 allow a.com"
pluck add "onetime M12-14 allow https://a.com/blah"

```

--------------------------------

### Set Plucky Delay for Rule Application

Source: https://docs.pluckeye.net/family

Applies a delay to Plucky rule changes, providing a window to revert unintended modifications. This can be used as a safety net against accidental or malicious configuration changes.

```bash
pluck + delay 1d
```

--------------------------------

### Pluckeye: Using 'try' Rules for Testing

Source: https://docs.pluckeye.net/release-notes

Illustrates the use of 'try' rules in Pluckeye, which allow for temporary application of blocking, blotting, or fleeing rules. These rules can be removed immediately without delay, facilitating safe experimentation with new blocking strategies.

```bash
pluck delay 1h
pluck + try block um.com
pluck - try block um.com      # block um.com removed immediately
pluck + try flee word pizza
pluck - try flee word pizza   # flee word pizza removed immediately
```

--------------------------------

### Schedule Safe Browsing in Plucky

Source: https://docs.pluckeye.net/family

Configures a schedule for the 'safe' browsing feature in Plucky, allowing it to be disabled during specific hours. This provides flexibility for users who may not want safe browsing constantly enabled.

```bash
pluck + when 0-10,12-24 safe     # disable safe mode from 10-12 am
```

--------------------------------

### Pluckeye Command: Abort Future Matches

Source: https://docs.pluckeye.net/release-notes

Demonstrates how to use the `pluck abort` command to remove specific entries from future blocking or allowing rules. It shows examples of aborting based on exact terms or partial matches.

```bash
pluck + delay 10
pluck + allow good.com
pluck + allow oops.com
pluck abort oops.com            # remove oops.com from future
pluck abort oops                # would also work
```

--------------------------------

### Allow All Programs by Default (Pluckeye CLI)

Source: https://docs.pluckeye.net/how-to-allow-a-program

Shows two methods for allowing all programs by default. The recommended approach involves allowing specific ports (like 443 and 80), while the less recommended method involves disabling the system feature entirely.

```bash
pluck + allow port 443
pluck + allow port 80
```

--------------------------------

### Export and Grep Pluckeye Configuration Rules (Unix)

Source: https://docs.pluckeye.net/release-notes

This demonstrates how to export Pluckeye's configuration and use 'grep' on Unix-like systems to search for specific rules. 'pluck export | grep youtube' filters the exported configuration for lines containing 'youtube'. 'pluck grep youtube.com' directly searches for rules related to youtube.com.

```bash
pluck export | grep youtube
pluck grep youtube.com       # ditto
```

--------------------------------

### Enable Firefox Support in Pluckeye

Source: https://docs.pluckeye.net/one-dot-zero

Applies necessary commands to ensure Pluckeye functions correctly with Firefox. This involves two commands: 'okfirefox' to enable specific settings and 'repair' to fix any potential issues.

```bash
pluck + okfirefox
pluck repair
```

--------------------------------

### Schedule General Access with Plucky

Source: https://docs.pluckeye.net/tips

Illustrates how to schedule general access to all programs and sites using Plucky's 'when' command. This can be used for a weekly 'whiteout' period, allowing unrestricted access for a set duration. The command allows specifying days and time ranges.

```bash
pluck + when M10-12 allow everything
```

--------------------------------

### Specify Delays for Features with Plucky CLI

Source: https://docs.pluckeye.net/delay

This command allows setting specific delays for adding or removing features. It requires using the '^feature:' syntax to ensure the pattern has sufficient specificity to override internal Plucky rules. The example shows how to set a 24-hour delay for removing the 'nhb' feature.

```bash
pluck delay 24h "- ^feature:nhb"
```

--------------------------------

### Configure Sometimes Rules in Pluckeye

Source: https://docs.pluckeye.net/release-notes

Adds 'sometimes' rules to Pluckeye, which apply specific configurations based on time and day. These rules can be used to allow or deny access to websites or the entire internet during certain periods. The examples demonstrate various time-based scheduling options.

```bash
pluckui add "sometimes 0-6&20-24 blackout"               # allow nothing at night
```

```bash
pluckui add "sometimes 12-13 whiteout"                   # allow everything over lunch
```

```bash
pluckui add "sometimes MWF18-19 allow amazon.com"        # Mon, Wed, Fri 6-7pm
```

```bash
pluckui add "sometimes M8-9&13-15.T10-11 allow ebay.com" # Mon 8-9am and 1-3pm, Tue 10-11am
```

--------------------------------

### Allowing WebKit (Safari & App Store) on Older macOS with Plucky

Source: https://docs.pluckeye.net/faq

For macOS versions 10.12 and below, allowing the App Store might require allowing WebKit, which includes Safari. This example shows how to grant periodic access to WebKit, specifically on Mondays from 10 am to 12 pm.

```bash
pluck + allow program App Store
pluck + when M10-12 allow program com.apple.WebKit
```

--------------------------------

### Pluckeye Fixed Date and Time Scheduling with 'when'

Source: https://docs.pluckeye.net/when

Illustrates scheduling a site's availability within a specific fixed date and time range using the 'when' modifier. The format requires start and end times in YYYY.MM.DD.hh:mm:ss format.

```pluckeye
pluck + when 2024.12.31.00:00:00-2024.12.31.23:59:59 allow amazon.de
```

--------------------------------

### Allow Network Access for Programs by Host, IP, or Port (Pluckeye CLI)

Source: https://docs.pluckeye.net/how-to-allow-a-program

Illustrates how to associate network access rules (hosts, IPs, ports) with specific programs. This enables fine-grained control, allowing a program only to communicate with designated network endpoints.

```bash
pluck + allow host:microsoft.com program foo.exe
pluck + allow ipv4:1.2.3.4 program foo.exe
pluck + allow port:53 program foo.exe
```

--------------------------------

### Block URLs Starting with a Prefix and Containing a Word using Pluckeye Flee

Source: https://docs.pluckeye.net/flee

This command blocks web pages that start with a specific URL prefix and also contain a particular word. It's useful for blocking sections of a website.

```bash
pluck + flee http://example.com/r example.com word mastaccioli
```

--------------------------------

### Allow Programs by Filename, Path, or Directory (Pluckeye CLI)

Source: https://docs.pluckeye.net/how-to-allow-a-program

Demonstrates how to use the Pluckeye command-line interface (CLI) to allow programs based on their executable filename, absolute path, or directory. This is a fundamental way to grant specific applications network access.

```bash
pluck + allow program foo.exe
pluck + allow program:C:\\Windows\\System32\\notepad.exe
pluck + allow program /usr/bin/env
```

--------------------------------

### Allow Programs for Specific Users (Pluckeye CLI)

Source: https://docs.pluckeye.net/how-to-allow-a-program

Shows how to restrict program allow rules to a particular user account. This allows for granular control over which users can run specific applications without being blocked by Pluckeye.

```bash
pluck + allow user jane program foo.exe
```

--------------------------------

### Reduce Pluckeye Delay

Source: https://docs.pluckeye.net/one-dot-zero

Sets the Pluckeye delay to 0. This is recommended for Firefox users before updating. The command adjusts the delay setting within Pluckeye.

```bash
pluck + delay 0
```

--------------------------------

### Schedule Website Access with Plucky

Source: https://docs.pluckeye.net/tips

Shows how to schedule access to specific websites using Plucky's 'when' command. This allows for time-based access rules, enabling sites only during specified hours or days. The 'hrs3' format is used for time and day specification.

```bash
pluck + when MTWRF10-12 allow youtube.com
pluck + when 10-12 allow amazon.com
```

--------------------------------

### Preview Expedite Requests

Source: https://docs.pluckeye.net/expedite

In Plucky versions 1.0.64 and above, this command allows users to preview which expedite requests would be created without actually submitting them. This is useful for managing multiple pending changes and ensuring the correct ones are expedited.

```bash
pluck -n expedite

```

--------------------------------

### Run Sysinspect on Mac OS X

Source: https://docs.pluckeye.net/sysinspect

This snippet shows how to execute the Sysinspect tool on Mac OS X. It includes steps to navigate to the desktop, move the executable, make it executable, and run it with or without sudo privileges. The tool may take up to 10 minutes to complete.

```shell
cd
cd Desktop
mv ../Downloads/sysinspect-macosx ./
chmod +x sysinspect-macosx
sudo ./sysinspect-macosx
```

```shell
cd
cd Desktop
mv ../Downloads/sysinspect-macosx ./
chmod +x sysinspect-macosx
./sysinspect-macosx
```

--------------------------------

### Set Plucky delay to 0

Source: https://docs.pluckeye.net/how-to-enforce-a-dns-filtering-service

Sets the Plucky delay to 0, ensuring commands take immediate effect. This is a prerequisite for the subsequent commands in this guide.

```bash
pluck delay 0

```

--------------------------------

### Applying Delay Patterns for Specific Rules

Source: https://docs.pluckeye.net/delay

Demonstrates using delay patterns to apply specific delays to certain Plucky rules, such as allowing YouTube URLs or blocking/allowing specific phrases. The content within double quotes is the delay pattern.

```pluck
pluck delay 45m "+ allow https://www.youtube.com/"
pluck delay 10h "- block"
pluck delay 24h "+ allow everything"
```

--------------------------------

### Abmindicate Until a Time (Windows)

Source: https://docs.pluckeye.net/abmindicate

This command uses Abmindicate to abdicate administrator rights for a specified duration starting from the current time. The 'until now+3d' indicates that the abdication will last for 3 days.

```batch
abmindicate until now+3d
```

--------------------------------

### Export Pluckeye Settings (Windows)

Source: https://docs.pluckeye.net/one-dot-zero

Exports current Pluckeye settings to a file named 'old-pluckeye-settings.txt' on the desktop and creates a backup. This command is specific to Windows operating systems.

```bash
cd %HOMEPATH%\Desktop
pluck export > old-pluckeye-settings.txt
copy old-pluckeye-settings.txt old-pluckeye-settings.bak
```

--------------------------------

### Enable or Disable System-Wide Blocking (Pluckeye CLI)

Source: https://docs.pluckeye.net/how-to-allow-a-program

Demonstrates commands to enable or disable Pluckeye's system-wide blocking features. `pluck + system` typically enables default blocking, while `pluck - system` disables it, which is generally not recommended.

```bash
pluck + system
pluck + nhb
pluck - system
```

--------------------------------

### Make Expedite Request via Console

Source: https://docs.pluckeye.net/expedite

Initiates an expedite request for pending configuration changes directly from the console. This command can be used without arguments to expedite all pending changes, or with a pattern to target specific changes.

```bash
pluck expedite

```

```bash
pluck + delay 99
pluck + allow foo.com
pluck + allow bar.com
pluck expedite foo

```

--------------------------------

### Time-Based Program Allow Rules (Pluckeye CLI)

Source: https://docs.pluckeye.net/how-to-allow-a-program

Explains how to configure Pluckeye to allow programs only during specific time windows. This is useful for managing application access based on daily schedules or work hours.

```bash
pluck + when 11-12 allow program foo.exe
```

--------------------------------

### Add Delay Rule in Pluckeye (Shell)

Source: https://docs.pluckeye.net/release-notes

Demonstrates how to add a delay rule to Pluckeye. This command allows for immediate changes to the delay setting, as shown in the example where changing the delay to 2 is instantaneous.

```shell
pluck add "delay 1"
pluck add "delay 2" # immediately changes delay to 2
```

--------------------------------

### Set Delayed Rule Removal - Pluckeye CLI

Source: https://docs.pluckeye.net/release-notes

This command allows setting a specific delay for the removal of block rules. The example sets a 10-minute delay for removing any rule that involves blocking.

```bash
pluck + "delay 10m - block"
```

--------------------------------

### Clear and Import Plucky Configurations

Source: https://docs.pluckeye.net/faq

Removes all existing settings and imports a new configuration file. This is useful for a complete reset or applying a new set of rules.

```bash
pluck export >settings.txt
$EDITOR settings.txt
pluck clear
pluck import settings.txt
```

--------------------------------

### Import Allow List - Pluckeye CLI

Source: https://docs.pluckeye.net/release-notes

This command allows importing a list of URLs or hosts to be allowed by Pluckeye. It takes a file path as an argument, where each line in the file should be a URL or host entry.

```bash
echo https://www.reddit.com/r/good >good-urls.txt
pluck import-allow good-urls.txt
```

--------------------------------

### Pluckeye Command: Synchronize and Upload

Source: https://docs.pluckeye.net/release-notes

Highlights the `pluck upload` and `pluck sync` commands, noting improvements in reliability for synchronization operations. It also mentions that imported configurations might still have issues.

```bash
pluck upload
pluck sync
```

--------------------------------

### Abmindicate with Exceptions (Windows)

Source: https://docs.pluckeye.net/abmindicate

Example of using Abmindicate to abdicate administrator rights, with an exception during specific hours on specific days. The 'except A10-11' part specifies the time range when administrator rights should NOT be abdicated.

```batch
abmindicate except A10-11
```

--------------------------------

### Clear Plucky Default Rules

Source: https://docs.pluckeye.net/how-to-block-facebook-most-of-the-time

This command removes all existing Plucky rules, including those for blocking images and videos. It's a starting point for defining custom blocking or allowing rules.

```bash
pluck clear
```

--------------------------------

### Pluckeye: Find, Replace, and Import Rules

Source: https://docs.pluckeye.net/release-notes

This command sequence demonstrates how to find specific content, replace it with a new rule, and then import that rule into Pluckeye. It's useful for managing and updating blocking or allowing rules.

```bash
pluck find stuff | pluck replace allow "when $time block" | pluck import -
```

--------------------------------

### Whitelist a Site using Pluckeye Command Line

Source: https://docs.pluckeye.net/faq

This command allows you to whitelist a specific website using the Pluckeye command-line interface. The change takes effect after the Pluckeye delay waiting period. This is an alternative to using the browser extension.

```bash
pluck + allow example.com
```

--------------------------------

### Allowing Network Printer Ports with Plucky

Source: https://docs.pluckeye.net/faq

To use a network printer when the system feature is enabled in Plucky, specific ports need to be allowed. This example shows how to allow ports 3910 and 3911.

```bash
pluck + allow port 3910
pluck + allow port 3911
```

--------------------------------

### Configuring Plucky for Homebrew on macOS

Source: https://docs.pluckeye.net/faq

This section details how to configure Plucky to work with Homebrew on macOS. It involves setting up environment variables for Homebrew and then allowing necessary hosts. An alternative involves modifying the Homebrew Dockerfile or using periodic whiteouts for specific time windows.

```bash
cat >~/.pluckeye.homebrew.env <<EOF
export HOMEBREW_DEVELOPER=pluckeye
export HOMEBREW_CURL_PATH=/usr/local/bin/curl
EOF
for i in ~/.bashrc ~/.bash_profile ~/.bash_login ~/.profile; do
    [ -f $i ] && break
done
echo source ~/.pluckeye.homebrew.env >>$i
source ~/.pluckeye.homebrew.env

pluck + allow bintray.com
pluck + allow gnu.org

pluck + when A12-14 allow everything
```

--------------------------------

### Plucky Command: Allow Program on OS

Source: https://docs.pluckeye.net/release-notes

Shows how to configure Plucky to allow a specific program to run on a particular operating system. This is useful for granting exceptions to blocking rules.

```bash
pluck + allow os:windows example.com
```

--------------------------------

### Add Deny Rule for ISO Images

Source: https://docs.pluckeye.net/release-notes

This command adds a rule to deny the download or execution of files with the ISO image format. This is a security measure to prevent the execution of potentially harmful disk images.

```bash
pluck add "Deny application/x-iso9660-image"

```

--------------------------------

### Add Website to Allowlist (Pluckeye)

Source: https://docs.pluckeye.net/release-notes

This command adds a specified website to the allowlist. It demonstrates the new syntax for adding entries, replacing the older 'pluckui' command with 'pluck'.

```bash
pluck add "allow a.com"
```

--------------------------------

### Disable Specific Browser with Plucky

Source: https://docs.pluckeye.net/family

Uses Plucky to disable a specific browser (e.g., Brave) for all users except those explicitly allowed. This can be used to enforce the use of a particular browser or to prevent access to certain applications.

```bash
pluck + nobrave
```

--------------------------------

### Export and Import Plucky Configurations

Source: https://docs.pluckeye.net/faq

Allows modification of Plucky configurations using a text editor. Settings are exported to a file, edited, and then imported back into Plucky.

```bash
pluck export >settings.txt
$EDITOR settings.txt
pluck import settings.txt
```

--------------------------------

### Pluckeye Command: Evaluate URLs with Context

Source: https://docs.pluckeye.net/release-notes

Illustrates the `pluck eval` command for evaluating URLs against current Pluckeye rules, considering context URLs. It shows how to check if a URL is allowed or blocked based on the configuration.

```bash
pluck + allow ok.com + block image/
pluck eval http://um.com/ image                # no
pluck eval http://ok.com/ image                # ok
pluck eval http://um.com/ http://ok.com/ image # ok
```

--------------------------------

### Pluckeye Command: User and Program Rules

Source: https://docs.pluckeye.net/release-notes

Illustrates how to apply Pluckeye rules based on specific users and programs. This allows for granular control over internet access for different applications or user accounts.

```bash
pluck + allow user:jon program:emacs
pluck + block user:jon program:vi
```

--------------------------------

### Set Plucky Delay Timer

Source: https://docs.pluckeye.net/how-to-block-facebook-most-of-the-time

This command sets a delay timer for Plucky, allowing a grace period before blocking takes effect. This is useful for getting accustomed to Plucky's behavior or for quick recovery from mistakes.

```bash
pluck delay 2 minutes
```

--------------------------------

### Set Level and Delay with Immediate Effect

Source: https://docs.pluckeye.net/release-notes

This sequence of commands shows how to set the Pluckeye level and delay. It also demonstrates how to override the delay for an immediate level change using the 'please' keyword, allowing for quick adjustments to security settings.

```bash
pluck set "level 1"
pluck set "delay 1"
pluck please set "level 2" # ok

```

--------------------------------

### Apply Delayed Blocking Rule in Pluckeye

Source: https://docs.pluckeye.net/release-notes

This command demonstrates how to apply a delayed blocking rule in Pluckeye. The example shows delaying the removal of any block for 24 hours using the '- block' pattern. This allows for temporary exceptions or phased changes to blocking rules.

```bash
pluck + delay 24h "- block"
```

--------------------------------

### Delayed Plucky Configuration Changes (Non-Zero Delay)

Source: https://docs.pluckeye.net/delay

Illustrates how Plucky commands that increase access are delayed when the delay setting is active. It shows adding a delay and then allowing a site, with the change taking effect only after the delay elapses.

```bash
pluck + delay 30
pluck + allow b.com
```

--------------------------------

### Disable Pluckeye Feature via Console

Source: https://docs.pluckeye.net/features

Disables a specific feature in Pluckeye by executing a console command. This command requires administrative privileges and takes the feature name as an argument. For example, to disable the 'system' feature, you would run `pluck - system`.

```bash
pluck - <feature>
# Example:
pluck - system
```

--------------------------------

### Export and Find Pluckeye Configuration Rules

Source: https://docs.pluckeye.net/release-notes

These commands are used to export Pluckeye's current configuration and then search within it. 'pluck export | findstr youtube' filters the exported configuration for lines containing 'youtube' on Windows. 'pluck find youtube.com' directly searches for rules related to youtube.com.

```bash
pluck export | findstr youtube
pluck find youtube.com       # ditto
pluck find present youtube.com # limit search to rules effective at present
pluck find future  youtube.com # limit search to future changes
```

--------------------------------

### Enable Pluckeye Feature via Console

Source: https://docs.pluckeye.net/features

Enables a specific feature in Pluckeye by executing a console command. This command requires administrative privileges and takes the feature name as an argument. For example, to enable the 'system' feature, you would run `pluck + system`.

```bash
pluck + <feature>
# Example:
pluck + system
```

--------------------------------

### Allow Specific Websites to Override Flee Rules in Pluckeye

Source: https://docs.pluckeye.net/flee

This demonstrates how to use the 'allow' command to ensure a website is not blocked, even if it contains terms that would otherwise trigger the 'flee' command. This takes precedence over general 'flee' rules.

```bash
pluck + allow example.com
pluck + flee word pizza
```

--------------------------------

### Block Websites with Flee Word - Pluckeye CLI

Source: https://docs.pluckeye.net/how-to-block-only-bad-sites

This command uses the 'flee' directive in Pluckeye to block all pages containing a specified word. It's effective for blocking content but may block entire sites if the word is common. Ensure Pluckeye is installed and configured.

```bash
pluck + flee word pizza
```

--------------------------------

### Implement Per-Program Whiteout/Blackout (Pluckeye)

Source: https://docs.pluckeye.net/release-notes

This functionality allows for specific programs to be whitelisted or blacklisted. It shows how to apply these rules to executables, including options for timing (e.g., 'sometimes 8-9').

```bash
pluckui add "program /usr/lib/virtualbox/VirtualBox whiteout"
pluckui add "program /usr/lib/virtualbox/VBoxNetNAT whiteout"
pluckui add "sometimes 8-9 program /usr/bin/ruby whiteout"
```

--------------------------------

### Unblock Programs by Domain Name on Linux with Plucky

Source: https://docs.pluckeye.net/faq

Allows specific domain names on Linux systems. This is an alternative to allowing by program name and is useful for services that rely on specific domains.

```bash
pluck + allow steampowered.com
pluck + allow steamcommunity.com
pluck + allow steamgames.com
pluck + allow steamusercontent.com
pluck + allow steamcontent.com
pluck + allow steamstatic.com
pluck + allow akamaihd.net
```

--------------------------------

### Time-Based and User-Specific Program Allow Rules (Pluckeye CLI)

Source: https://docs.pluckeye.net/how-to-allow-a-program

Combines time-based restrictions with user specificity for program allow rules. This provides the most granular control, allowing a program only for a specific user during a defined time period.

```bash
pluck + when 11-12 allow user jane program foo.exe
```

--------------------------------

### Set Delay and Handle Errors in Pluckeye (Shell)

Source: https://docs.pluckeye.net/release-notes

Illustrates setting a delay value and demonstrates potential errors, specifically a 'Segmentation fault', that can occur with incorrect 'pluck set' commands. This highlights the importance of correct syntax for stability.

```shell
$ pluck set 'delay 1'
$ pluck set 'delay 0'
Segmentation fault
```

--------------------------------

### Lock All Delays with Plucky CLI

Source: https://docs.pluckeye.net/delay

The `lockdelays` command prevents any changes to existing delay settings for a period. This is useful for enforcing a consistent delay across all configurations when making significant changes. The example shows how to set a 24-hour delay for 'allow everything' and a 600-second general delay before enabling `lockdelays`.

```bash
pluck + delay 24h "+ allow everything"
pluck + delay 600
pluck + lockdelays
```

--------------------------------

### Manage Plucky Configuration (Shell)

Source: https://docs.pluckeye.net/reset

Commands for clearing the current Plucky configuration and importing a saved configuration file. This is a crucial step after reinstalling Plucky to restore previous settings. Ensure the configuration file is in the correct directory before importing.

```shell
pluck clear
cd Desktop
pluck import pluckeye-configuration.txt
```
Tokens:
Raw