bytestashy 0.3.0

A command-line interface for ByteStash for the easy posting of snippets without opening a browser.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

# bytestashy

`bytestashy` is a CLI application that communicates with the ByteStash API to quickly store files as snippets or retrieve existing ones.

## Installation

A recent Rust installation is required (at least Rust 1.74 with Edition 2024). The tool can be installed directly from crates.io:

```bash
cargo install bytestashy
```

Alternatively, clone this repository and build from source:

```bash
cargo build --release
```

## Commands

### Authentication

Before the first upload, an API key for ByteStash must be generated:

```bash
bytestashy login <API_URL>
```

Configuration is stored in an OS-specific config folder (for example under `$XDG_CONFIG_HOME/bytestashy/config.json` on Linux). The API key itself is saved securely in your system keyring.

### Create Snippets

Upload files as snippets. The program will interactively prompt for title, description, visibility and categories:

```bash
bytestashy create <FILES...>
```

### List Snippets

Display a paginated list of your snippets:

```bash
bytestashy list [OPTIONS]
```

**Options:**
- `--all, -a`: Display all snippets (no pagination)
- `--number, -n <N>`: Page size (default: 10)
- `--page, -p <N>`: Page number to display (starting at 1)

### Get Snippets

Retrieve and download a snippet by ID:

```bash
bytestashy get <ID>
```

The command will show snippet details and prompt whether to download the files.

### Update Snippets

Replace all files in an existing snippet:

```bash
bytestashy update <ID> <FILES...>
```

The program will prompt for updated title, description, visibility and categories, pre-filling with current values.

### Delete Snippets

Delete a snippet by ID:

```bash
bytestashy delete <ID> [OPTIONS]
```

**Options:**
- `--force, -f`: Skip confirmation dialog

### Search Snippets

Search through your snippets with various options:

```bash
bytestashy search <QUERY> [OPTIONS]
```

**Options:**
- `--sort, -s <ORDER>`: Sort order (newest, oldest, alpha-asc, alpha-desc)
- `--search-code`: Search within code content (not just titles/descriptions)

**Available sort options:**
- `newest` - Most recently updated first
- `oldest` - Oldest first  
- `alpha-asc` - Alphabetical by title (A-Z)
- `alpha-desc` - Alphabetical by title (Z-A)

### Shell Completions

Generate shell completion scripts for enhanced command-line experience:

```bash
bytestashy --shell <SHELL>
```

**Supported shells:** `bash`, `zsh`, `fish`, `powershell`

**Installation examples:**

**Bash:**
```bash
bytestashy --shell bash > /etc/bash_completion.d/bytestashy
# or for user-only installation:
bytestashy --shell bash > ~/.local/share/bash-completion/completions/bytestashy
```

**Zsh:**
```bash
bytestashy --shell zsh > ~/.zsh/completions/_bytestashy
# Make sure ~/.zsh/completions is in your $fpath
```

**Fish:**
```bash
bytestashy --shell fish > ~/.config/fish/completions/bytestashy.fish
```

After installation, restart your shell or source the completion file to enable tab completion for all bytestashy commands and options.

## License

This project is licensed under the GPLv3. See [LICENSE](LICENSE).