chore: update readme 83054334
Steve · 2026-02-20 22:01 1 file(s) · +39 −3
README.md +39 −3
71 71 

            

            
            

                72
                72
                 
                
## Usage

            

            
            

                73
                73
                 
                

            

            
            

                
                74
                +
                
### CLI

            

            
            

                
                75
                +
                

            

            
            

                
                76
                +
                
```

            

            
            

                
                77
                +
                
sipp [OPTIONS] [FILE] [COMMAND]

            

            
            

                
                78
                +
                
```

            

            
            

                
                79
                +
                

            

            
            

                
                80
                +
                
#### Commands

            

            
            

                
                81
                +
                

            

            
            

                
                82
                +
                
| Command | Description |

            

            
            

                
                83
                +
                
|---|---|

            

            
            

                
                84
                +
                
| `server` | Start the web server |

            

            
            

                
                85
                +
                
| `tui` | Launch the interactive TUI |

            

            
            

                
                86
                +
                
| `auth` | Save remote URL and API key to config file |

            

            
            

                
                87
                +
                

            

            
            

                
                88
                +
                
#### Arguments

            

            
            

                
                89
                +
                

            

            
            

                
                90
                +
                
| Argument | Description |

            

            
            

                
                91
                +
                
|---|---|

            

            
            

                
                92
                +
                
| `[FILE]` | File path to create a snippet from |

            

            
            

                
                93
                +
                

            

            
            

                
                94
                +
                
#### Options

            

            
            

                
                95
                +
                

            

            
            

                
                96
                +
                
| Option | Description |

            

            
            

                
                97
                +
                
|---|---|

            

            
            

                
                98
                +
                
| `-r, --remote <URL>` | Remote server URL (e.g. `http://localhost:3000`) (env: `SIPP_REMOTE_URL`) |

            

            
            

                
                99
                +
                
| `-k, --api-key <KEY>` | API key for authenticated operations (env: `SIPP_API_KEY`) |

            

            
            

                
                100
                +
                

            

            
            

                74
                101
                 
                
### Server

            

            
            

                75
                102
                 
                

            

            
            

                76
                103
                 
                
Sipp includes a built-in web server powered by Axum. Start it with:

            

            
        
            

            
            

                103
                130
                 
                

            

            
            

                104
                131
                 
                
### TUI

            

            
            

                105
                132
                 
                

            

            
            

                106
                
                -
                
The Sipp TUI makes it easy to create, copy, share, and manage your snippets either locally or remotely.

            

            
            

                
                133
                +
                
The Sipp TUI makes it easy to create, copy, share, and manage your snippets either locally or remotely. Launch it with:

            

            
            

                
                134
                +
                

            

            
            

                
                135
                +
                
```bash

            

            
            

                
                136
                +
                
# Launch TUI (default behavior when no file argument is given)

            

            
            

                
                137
                +
                
sipp

            

            
            

                
                138
                +
                

            

            
            

                
                139
                +
                
# Or explicitly

            

            
            

                
                140
                +
                
sipp tui

            

            
            

                
                141
                +
                

            

            
            

                
                142
                +
                
# With remote options

            

            
            

                
                143
                +
                
sipp -r https://sipp.so -k your-api-key

            

            
            

                
                144
                +
                
```

            

            
            

                107
                145
                 
                

            

            
            

                108
                146
                 
                
#### Local Access

            

            
            

                109
                147
                 
                

            

            
        
            

            
            

                185
                223
                 
                
2. Set the environment variables `SIPP_API_KEY` and optionally `SIPP_AUTH_ENDPOINTS`

            

            
            

                186
                224
                 
                
3. Add a [volume](https://docs.railway.com/guides/volumes) to your service and mount it at `/data`

            

            
            

                187
                225
                 
                
4. Set `SIPP_DB_PATH` to `/data/sipp.sqlite` so the database persists across deploys

            

            
            

                188
                
                -
                

            

            
            

                189
                
                -
                
## Roadmap