Skip to content

Commit 80acf96

Browse files
committed
update docs from upload -> deploy, add deprecation notice
1 parent f23b5b7 commit 80acf96

30 files changed

+784
-428
lines changed

README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ curl -fsSL https://nsyte.run/get/install.sh | bash
3737
# Initialize project (interactive setup)
3838
nsyte init
3939

40-
# Upload website
41-
nsyte upload ./dist
40+
# Deploy website
41+
nsyte deploy ./dist
4242
```
4343

4444
## Table of Contents
@@ -80,8 +80,9 @@ deno task compile:all
8080
| ----------------------- | ------------------------------------------------ |
8181
| `nsyte` | Interactive setup wizard |
8282
| `nsyte init` | Initialize configuration |
83-
| `nsyte upload <dir>` | Upload files |
83+
| `nsyte deploy <dir>` | Deploy files |
8484
| `nsyte ls` | List published files |
85+
| `nsyte browse` | Interactive TUI browser for files |
8586
| `nsyte download <dir>` | Download files |
8687
| `nsyte run` | Run resolver server with npub subdomains |
8788
| `nsyte serve -d <div>` | Serve local nsite files from directory (current dir is default) |
@@ -91,26 +92,26 @@ deno task compile:all
9192
| `nsyte ci` | Generate CI/CD credentials (nbunksec) |
9293
| `nsyte bunker <action>` | Manage NIP-46 bunkers |
9394

94-
### Uploading Files
95+
### Deploying Files
9596

9697
```bash
97-
# Basic upload
98-
nsyte upload ./dist
98+
# Basic deploy
99+
nsyte deploy ./dist
99100

100101
# With options
101-
nsyte upload ./dist --force --concurrency 8 --verbose
102+
nsyte deploy ./dist --force --concurrency 8 --verbose
102103

103104
# With metadata publishing
104-
nsyte upload ./dist --publish-profile --publish-relay-list --publish-server-list
105+
nsyte deploy ./dist --publish-profile --publish-relay-list --publish-server-list
105106

106107
# With NIP-89 app handler
107-
nsyte upload ./dist --app-handler --handler-kinds "1,30023"
108+
nsyte deploy ./dist --app-handler --handler-kinds "1,30023"
108109

109110
# With NIP-94 release artifacts (auto-create archive)
110-
nsyte upload ./dist --publish-file-metadata --version v1.0.0
111+
nsyte deploy ./dist --publish-file-metadata --version v1.0.0
111112

112113
# With NIP-94 release artifacts (use existing archives)
113-
nsyte upload ./dist --publish-file-metadata --version v1.0.0 --release-artifacts dist.tar.gz,dist.zip
114+
nsyte deploy ./dist --publish-file-metadata --version v1.0.0 --release-artifacts dist.tar.gz,dist.zip
114115
```
115116

116117
### Purging Files
@@ -331,7 +332,7 @@ nsyte ci
331332

332333
# Add the nbunksec to your CI/CD secrets (e.g., NBUNK_SECRET)
333334
# Then use in your pipeline:
334-
nsyte upload ./dist --nbunksec ${NBUNK_SECRET}
335+
nsyte deploy ./dist --nbunksec ${NBUNK_SECRET}
335336
```
336337

337338
**Security Best Practices:**
@@ -350,7 +351,7 @@ jobs:
350351
steps:
351352
- uses: actions/checkout@v3
352353
- uses: denoland/setup-deno@v1
353-
- run: nsyte upload ./dist --nbunksec ${{ secrets.NBUNK_SECRET }}
354+
- run: nsyte deploy ./dist --nbunksec ${{ secrets.NBUNK_SECRET }}
354355
```
355356
356357
## Configuration
@@ -442,7 +443,7 @@ nsyte supports [NIP-89](https://github.com/nostr-protocol/nips/blob/master/89.md
442443
**Command Line:**
443444
```bash
444445
# Publish app handler for specific event kinds
445-
nsyte upload ./dist --app-handler --handler-kinds "1,30023,30311"
446+
nsyte deploy ./dist --app-handler --handler-kinds "1,30023,30311"
446447
```
447448

448449
When enabled, other Nostr clients can suggest your nsite when users encounter the specified event types.
@@ -496,7 +497,7 @@ nsyte bunker migrate
496497
For client-side routing (React, Vue, etc.):
497498

498499
```bash
499-
nsyte upload ./dist --fallback=/index.html
500+
nsyte deploy ./dist --fallback=/index.html
500501
```
501502

502503
## Troubleshooting

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.18.0
1+
0.18.1

deno.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@nsyte/cli",
3-
"version": "0.18.0",
3+
"version": "0.18.1",
44
"description": "nsyte - publish your site to nostr and blossom servers",
55
"license": "MIT",
66
"exports": "./src/cli.ts",

docs/JSR_SETUP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Ensure your `deno.json` includes:
4040
```json
4141
{
4242
"name": "@nsyte/cli",
43-
"version": "0.18.0",
43+
"version": "0.18.1",
4444
"exports": "./src/cli.ts"
4545
}
4646
```

docs/guides/ci-cd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ jobs:
7070
RELAYS: "wss://some.relay.xyz,wss://another.relay.abc"
7171
SERVERS: "https://a.blossom.server.com,https://another.blossom.server"
7272
run: |
73-
nsyte upload ./dist -i \
73+
nsyte deploy ./dist -i \
7474
--nbunksec ${{ secrets.NBUNKSEC }} \
7575
--relays ${{ env.RELAYS }} \
7676
--servers ${{ env.SERVERS }} \

docs/guides/deployment.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ nsyte.
1010

1111
## Basic Deployment
1212

13-
The simplest way to deploy your site is using the `upload` command:
13+
The simplest way to deploy your site is using the `deploy` command:
1414

1515
```bash
16-
nsyte upload ./dist
16+
nsyte deploy ./dist
1717
```
1818

1919
This will:
@@ -35,7 +35,7 @@ Suitable for:
3535
Steps:
3636

3737
1. Build your site
38-
2. Run `nsyte upload`
38+
2. Run `nsyte deploy`
3939
3. Verify the deployment
4040

4141
### 2. Automated Deployment
@@ -70,34 +70,34 @@ Steps:
7070

7171
## Deployment Options
7272

73-
### Basic Upload
73+
### Basic Deploy
7474

7575
```bash
76-
nsyte upload ./dist
76+
nsyte deploy ./dist
7777
```
7878

79-
### Force Re-upload
79+
### Force Re-deploy
8080

8181
```bash
82-
nsyte upload ./dist --force
82+
nsyte deploy ./dist --force
8383
```
8484

8585
### Purge Deleted Files
8686

8787
```bash
88-
nsyte upload ./dist --purge
88+
nsyte deploy ./dist --purge
8989
```
9090

9191
### Set Concurrency
9292

9393
```bash
94-
nsyte upload ./dist --concurrency 8
94+
nsyte deploy ./dist --concurrency 8
9595
```
9696

9797
### SPA Support
9898

9999
```bash
100-
nsyte upload ./dist --fallback=/index.html
100+
nsyte deploy ./dist --fallback=/index.html
101101
```
102102

103103
## Deployment Checklist
@@ -122,7 +122,7 @@ Before deploying:
122122

123123
4. **Deployment**
124124
- [ ] Backup current site
125-
- [ ] Run upload
125+
- [ ] Run deploy
126126
- [ ] Verify deployment
127127
- [ ] Check site metadata
128128

@@ -160,7 +160,7 @@ Before deploying:
160160

161161
### Common Issues
162162

163-
1. **Upload Failures**
163+
1. **Deploy Failures**
164164
- Check network connectivity
165165
- Verify relay liveness
166166
- Ensure you are allowed to publish to provided relays

docs/guides/local-setup.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,10 @@ echo "<html><body><h1>Test Site</h1></body></html>" > index.html
6161
echo "# Test" > README.md
6262
```
6363

64-
### Test Upload
64+
### Test Deploy
6565

6666
```bash
67-
nsyte upload .
67+
nsyte deploy .
6868
```
6969

7070
### Verify Deployment
@@ -106,8 +106,8 @@ npx serve dist/
106106
### Deploy to Test Environment
107107

108108
```bash
109-
# Upload to staging relays first
110-
nsyte upload ./dist --relays "wss://test-relay.example.com"
109+
# Deploy to staging relays first
110+
nsyte deploy ./dist --relays "wss://test-relay.example.com"
111111
```
112112

113113
## Development Commands
@@ -130,7 +130,7 @@ deno task test
130130
Use verbose output for debugging:
131131

132132
```bash
133-
nsyte upload . --verbose
133+
nsyte deploy . --verbose
134134
```
135135

136136
## Configuration Tips

docs/guides/nip94-cicd.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
2828
- name: Publish Linux build
2929
run: |
30-
nsyte upload dist \
30+
nsyte deploy dist \
3131
--publish-file-metadata \
3232
--version ${{ github.ref_name }} \
3333
--release-artifacts dist-linux.tar.gz \
@@ -47,7 +47,7 @@ jobs:
4747
4848
- name: Publish Windows build
4949
run: |
50-
nsyte upload dist `
50+
nsyte deploy dist `
5151
--publish-file-metadata `
5252
--version ${{ github.ref_name }} `
5353
--release-artifacts dist-windows.zip `
@@ -93,7 +93,7 @@ jobs:
9393
9494
- name: Publish artifact
9595
run: |
96-
nsyte upload dist \
96+
nsyte deploy dist \
9797
--publish-file-metadata \
9898
--version ${{ github.event.release.tag_name }} \
9999
--release-artifacts ${{ matrix.artifact }} \
@@ -114,7 +114,7 @@ variables:
114114
.release_template: &release_definition
115115
stage: release
116116
script:
117-
- nsyte upload dist
117+
- nsyte deploy dist
118118
--publish-file-metadata
119119
--version $VERSION
120120
--release-artifacts $ARTIFACT_PATH
@@ -178,7 +178,7 @@ pipeline {
178178
sh 'npm ci && npm run build'
179179
sh 'tar -czf dist-linux.tar.gz dist/'
180180
sh """
181-
nsyte upload dist \
181+
nsyte deploy dist \
182182
--publish-file-metadata \
183183
--version ${params.VERSION} \
184184
--release-artifacts dist-linux.tar.gz \
@@ -193,7 +193,7 @@ pipeline {
193193
sh 'npm ci && npm run build'
194194
sh 'tar -czf dist-macos.tar.gz dist/'
195195
sh """
196-
nsyte upload dist \
196+
nsyte deploy dist \
197197
--publish-file-metadata \
198198
--version ${params.VERSION} \
199199
--release-artifacts dist-macos.tar.gz \
@@ -208,7 +208,7 @@ pipeline {
208208
bat 'npm ci && npm run build'
209209
powershell 'Compress-Archive -Path dist/* -DestinationPath dist-windows.zip'
210210
bat """
211-
nsyte upload dist ^
211+
nsyte deploy dist ^
212212
--publish-file-metadata ^
213213
--version ${params.VERSION} ^
214214
--release-artifacts dist-windows.zip ^
@@ -231,7 +231,7 @@ Use git tags for consistent versioning:
231231
```bash
232232
# In your CI script
233233
VERSION=$(git describe --tags --abbrev=0)
234-
nsyte upload --version "$VERSION" ...
234+
nsyte deploy --version "$VERSION" ...
235235
```
236236

237237
### 2. Secure Key Management
@@ -266,12 +266,12 @@ Take advantage of nsyte's append capability:
266266
# Job 1: Build and release Linux
267267
- name: Release Linux
268268
run: |
269-
nsyte upload --version v1.0.0 --release-artifacts linux.tar.gz
269+
nsyte deploy --version v1.0.0 --release-artifacts linux.tar.gz
270270
271271
# Job 2: Build and release Windows (runs later)
272272
- name: Release Windows
273273
run: |
274-
nsyte upload --version v1.0.0 --release-artifacts windows.zip
274+
nsyte deploy --version v1.0.0 --release-artifacts windows.zip
275275
# Automatically appends to existing v1.0.0 release
276276
```
277277
@@ -291,7 +291,7 @@ upload_with_retry() {
291291
while [ $attempt -le $max_attempts ]; do
292292
echo "Upload attempt $attempt of $max_attempts"
293293

294-
if nsyte upload dist \
294+
if nsyte deploy dist \
295295
--publish-file-metadata \
296296
--version "$VERSION" \
297297
--release-artifacts "$1" \
@@ -339,7 +339,7 @@ RELEASE_NOTES=$(git log --pretty=format:"- %s" $(git describe --tags --abbrev=0
339339
echo "$RELEASE_NOTES" > release-notes.txt
340340

341341
# Include in your release
342-
nsyte upload dist \
342+
nsyte deploy dist \
343343
--publish-file-metadata \
344344
--version "$VERSION" \
345345
--release-artifacts dist.tar.gz,release-notes.txt
@@ -366,7 +366,7 @@ When updating a release with a fixed artifact:
366366
Enable verbose output for troubleshooting:
367367

368368
```bash
369-
nsyte upload dist \
369+
nsyte deploy dist \
370370
--publish-file-metadata \
371371
--version v1.0.0 \
372372
--release-artifacts dist.tar.gz \

docs/guides/security-troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ nsyte ci # Follow interactive prompts
183183
echo $NBUNK_SECRET | head -c 50 # Should start with "nbunksec1"
184184

185185
# Test locally first
186-
nsyte upload ./dist --nbunksec $NBUNK_SECRET
186+
nsyte deploy ./dist --nbunksec $NBUNK_SECRET
187187

188188
# Check secret configuration in CI/CD platform
189189
# GitHub Actions: Repository Settings > Secrets

docs/guides/security.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ nsyte ci
7373
# This creates a dedicated nbunksec for CI/CD use
7474

7575
# Use in CI/CD with secrets
76-
nsyte upload ./dist --nbunksec ${{ secrets.NBUNK_SECRET }}
76+
nsyte deploy ./dist --nbunksec ${{ secrets.NBUNK_SECRET }}
7777
```
7878

7979
### Key Rotation
@@ -98,7 +98,7 @@ Choose relays carefully:
9898

9999
```bash
100100
# Use multiple trusted relays
101-
nsyte upload ./dist \
101+
nsyte deploy ./dist \
102102
--relays "wss://relay.damus.io,wss://relay.nostr.band,wss://nos.lol"
103103
```
104104

@@ -128,7 +128,7 @@ jobs:
128128
- name: Deploy
129129
env:
130130
NSYTE_BUNKER_KEY: ${{ secrets.NSYTE_BUNKER_KEY }}
131-
run: nsyte upload ./dist
131+
run: nsyte deploy ./dist
132132
```
133133
134134
### Content Security

0 commit comments

Comments
 (0)