> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payback.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# payback allow, on and off

> Which repositories payback records: the policy, named repositories, exclusions.

## Usage

```text theme={null}
                                                                                                    
 Usage: payback allow [OPTIONS] [target]                                                          
                                                                                                    
 Which repos payback records (~/.payback/allow): the policy, the named repos, the exclusions,   
 and what that means for the repo you're in.                                                        
                                                                                                    
                                                                                                    
 payback allow                            policy, repos, exclusions, this repo's status           
 payback allow public | named | every     set the policy (every warns and asks y/N)               
 payback allow <owner/name | path | .>    add a repo (. = the current one)                        
 payback allow --remove <repo | .>        take it off the list                                    
 payback allow --exclude <repo | .>       never record it, whatever the policy                    
 payback allow --include <repo | .>       undo an exclusion                                       
 payback on / payback off               shortcuts for the current repo                          
                                                                                                    
╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────╮
│   target      <str>  public | named | every, or a repo: owner/name, a path, or . for this one    │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮
│ --remove           take the repo off the list                                                    │
│ --exclude          never record the repo, whatever the policy                                    │
│ --include          undo an exclusion                                                             │
│ --yes              don't ask before `every`                                                      │
│ --help             Show this message and exit.                                                   │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
```

`payback allow` is the one command for the allow list; `payback on` and `payback off` are its shortcuts for the repository you're in. [Which repositories are recorded](https://docs.payback.sh/repositories.md) explains the policy; this page is the reference.

```text theme={null}
payback allow                            policy, repos, exclusions, this repo's status
payback allow public | named | every     set the policy (every warns and asks y/N; --yes skips)
payback allow <owner/name | path | .>    add a repo (. = the current one)
payback allow --remove <repo | .>        take it off the list
payback allow --exclude <repo | .>       never record it, whatever the policy (. also writes .payback-ignore)
payback allow --include <repo | .>       undo an exclusion (removes the file for .)
payback on / payback off               shortcuts for the current repo: include+add / exclude
```

## `payback on`

```text theme={null}
                                                                                                    
 Usage: payback on [OPTIONS]                                                                      
                                                                                                    
 Record this repo: drops its exclusion (and .payback-ignore) and names it if the policy wouldn't  
 cover it. The same as `payback allow --include .` plus `payback allow .`.                      
                                                                                                    
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                                      │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
```

## `payback off`

```text theme={null}
                                                                                                    
 Usage: payback off [OPTIONS]                                                                     
                                                                                                    
 Never record this repo, whatever the policy: writes .payback-ignore at its root (kept out of     
 git) and excludes it on the list. The same as `payback allow --exclude .`.                       
                                                                                                    
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                                      │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
```

## Examples

```bash theme={null}
payback allow                     # the policy, repos, exclusions, and this repo's status
payback allow public              # every public GitHub repo, now and later
payback allow named               # only the repos on the list
payback allow pallets/flask       # add one by name
payback allow .                   # add the repo you're in
payback allow --exclude acme/internal
payback off                       # never record this repo (writes .payback-ignore)
payback on                        # record this repo again
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.