Skip to content

Commit fcb8255

Browse files
committed
Re-arranged sections in README
1 parent 5516c76 commit fcb8255

File tree

1 file changed

+55
-55
lines changed

1 file changed

+55
-55
lines changed

README.md

Lines changed: 55 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,61 @@ claude-code-transcripts web SESSION_ID --gist
8989

9090
On macOS, API credentials are automatically retrieved from your keychain (requires being logged into Claude Code). On other platforms, provide `--token` and `--org-uuid` manually.
9191

92-
### JSON/JSONL files
92+
### Publishing to GitHub Gist
93+
94+
Use the `--gist` option to automatically upload your transcript to a GitHub Gist and get a shareable preview URL:
95+
96+
```bash
97+
claude-code-transcripts --gist
98+
claude-code-transcripts web --gist
99+
claude-code-transcripts json session.json --gist
100+
```
101+
102+
This will output something like:
103+
```
104+
Gist: https://gist.github.com/username/abc123def456
105+
Preview: https://gistpreview.github.io/?abc123def456/index.html
106+
Files: /var/folders/.../session-id
107+
```
108+
109+
The preview URL uses [gistpreview.github.io](https://gistpreview.github.io/) to render your HTML gist. The tool automatically injects JavaScript to fix relative links when served through gistpreview.
110+
111+
Combine with `-o` to keep a local copy:
112+
113+
```bash
114+
claude-code-transcripts json session.json -o ./my-transcript --gist
115+
```
116+
117+
**Requirements:** The `--gist` option requires the [GitHub CLI](https://cli.github.com/) (`gh`) to be installed and authenticated (`gh auth login`).
118+
119+
### Auto-naming output directories
120+
121+
Use `-a/--output-auto` to automatically create a subdirectory named after the session:
122+
123+
```bash
124+
# Creates ./session_ABC123/ subdirectory
125+
claude-code-transcripts web SESSION_ABC123 -a
126+
127+
# Creates ./transcripts/session_ABC123/ subdirectory
128+
claude-code-transcripts web SESSION_ABC123 -o ./transcripts -a
129+
```
130+
131+
### Including the source file
132+
133+
Use the `--json` option to include the original session file in the output directory:
134+
135+
```bash
136+
claude-code-transcripts json session.json -o ./my-transcript --json
137+
```
138+
139+
This will output:
140+
```
141+
JSON: ./my-transcript/session_ABC.json (245.3 KB)
142+
```
143+
144+
This is useful for archiving the source data alongside the HTML output.
145+
146+
### Converting from JSON/JSONL files
93147

94148
Convert a specific session file directly:
95149

@@ -138,60 +192,6 @@ claude-code-transcripts all -o ./my-archive
138192
claude-code-transcripts all --include-agents
139193
```
140194

141-
### Auto-naming output directories
142-
143-
Use `-a/--output-auto` to automatically create a subdirectory named after the session:
144-
145-
```bash
146-
# Creates ./session_ABC123/ subdirectory
147-
claude-code-transcripts web SESSION_ABC123 -a
148-
149-
# Creates ./transcripts/session_ABC123/ subdirectory
150-
claude-code-transcripts web SESSION_ABC123 -o ./transcripts -a
151-
```
152-
153-
### Publishing to GitHub Gist
154-
155-
Use the `--gist` option to automatically upload your transcript to a GitHub Gist and get a shareable preview URL:
156-
157-
```bash
158-
claude-code-transcripts --gist
159-
claude-code-transcripts web --gist
160-
claude-code-transcripts json session.json --gist
161-
```
162-
163-
This will output something like:
164-
```
165-
Gist: https://gist.github.com/username/abc123def456
166-
Preview: https://gistpreview.github.io/?abc123def456/index.html
167-
Files: /var/folders/.../session-id
168-
```
169-
170-
The preview URL uses [gistpreview.github.io](https://gistpreview.github.io/) to render your HTML gist. The tool automatically injects JavaScript to fix relative links when served through gistpreview.
171-
172-
Combine with `-o` to keep a local copy:
173-
174-
```bash
175-
claude-code-transcripts json session.json -o ./my-transcript --gist
176-
```
177-
178-
**Requirements:** The `--gist` option requires the [GitHub CLI](https://cli.github.com/) (`gh`) to be installed and authenticated (`gh auth login`).
179-
180-
### Including the source file
181-
182-
Use the `--json` option to include the original session file in the output directory:
183-
184-
```bash
185-
claude-code-transcripts json session.json -o ./my-transcript --json
186-
```
187-
188-
This will output:
189-
```
190-
JSON: ./my-transcript/session_ABC.json (245.3 KB)
191-
```
192-
193-
This is useful for archiving the source data alongside the HTML output.
194-
195195
## Development
196196

197197
To contribute to this tool, first checkout the code. You can run the tests using `uv run`:

0 commit comments

Comments
 (0)