Skip to content

Commit 40bda21

Browse files
b5b5
committed
redirects
1 parent 8092278 commit 40bda21

File tree

7 files changed

+217
-20
lines changed

7 files changed

+217
-20
lines changed

‎tailwindui-protocol/next.config.mjs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,22 +24,22 @@ export async function redirects() {
2424
// old design section
2525
{
2626
source: '/design',
27-
destination: '/layers',
27+
destination: '/docs/overview',
2828
permanent: true,
2929
},
3030
{
3131
source: '/design/content-addressing',
32-
destination: '/layers/blobs',
32+
destination: '/docs/blobs',
3333
permanent: true,
3434
},
3535
{
3636
source: '/design/data-transfer',
37-
destination: '/layers/blobs',
37+
destination: '/docs/blobs',
3838
permanent: true,
3939
},
4040
{
4141
source: '/design/dsht',
42-
destination: '/layers/sync',
42+
destination: '/docs/sync',
4343
permanent: true,
4444
},
4545

‎tailwindui-protocol/src/app/docs/cli/page.mdx‎

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
export const metadata = {
2+
title: 'Command Line Interface (CLI)',
3+
description: ''
4+
}
5+
6+
# CLI Commands
7+
Iroh has a single command line interface, common to all platforms & distributions.
8+
9+
10+
## iroh
11+
```
12+
Send data.
13+
14+
Usage: iroh [OPTIONS] <COMMAND>
15+
16+
Commands:
17+
provide Serve the data from the given path
18+
list List hashes
19+
validate Validate hashes
20+
shutdown Shutdown provider
21+
id Identify provider
22+
add Add data from the given path
23+
get Fetch the data from the hash
24+
get-ticket Fetch the data using a ticket for all provider information and authentication.
25+
addresses List addresses
26+
help Print this message or the help of the given subcommand(s)
27+
28+
Options:
29+
--keylog Log SSL pre-master key to file in SSLKEYLOGFILE environment variable
30+
-h, --help Print help
31+
-V, --version Print version
32+
```
33+
34+
## iroh provide
35+
```
36+
Serve the data from the given path
37+
38+
Usage: iroh provide [OPTIONS] [PATH]
39+
40+
Arguments:
41+
[PATH]
42+
43+
Options:
44+
-a, --addr <ADDR> Optional listening address, defaults to 127.0.0.1:4433
45+
--auth-token <AUTH_TOKEN> Auth token, defaults to random generated
46+
--rpc-port <RPC_PORT> Optional rpc port, defaults to 4919. Set to 0 to disable RPC [default: 4919]
47+
-h, --help Print help
48+
```
49+
50+
## iroh list
51+
```
52+
List hashes
53+
54+
Usage: iroh list [OPTIONS]
55+
56+
Options:
57+
--rpc-port <RPC_PORT> Optional rpc port, defaults to 4919 [default: 4919]
58+
-h, --help
59+
```
60+
61+
## iroh shutdown
62+
```
63+
Shutdown provider
64+
65+
Usage: iroh shutdown [OPTIONS]
66+
67+
Options:
68+
--force Shutdown mode. Hard shutdown will immediately terminate the process, soft shutdown will wait for all connections to close
69+
--rpc-port <RPC_PORT> Optional rpc port, defaults to 4919 [default: 4919]
70+
-h, --help
71+
```
72+
73+
## iroh id
74+
```
75+
Identify provider
76+
77+
Usage: iroh id [OPTIONS]
78+
79+
Options:
80+
--rpc-port <RPC_PORT> Optional rpc port, defaults to 4919 [default: 4919]
81+
-h, --help
82+
```
83+
84+
## iroh add
85+
```
86+
Add data from the given path
87+
88+
Usage: iroh add [OPTIONS] <PATH>
89+
90+
Arguments:
91+
<PATH> The path to the file or folder to add
92+
93+
Options:
94+
--rpc-port <RPC_PORT> Optional rpc port, defaults to 4919 [default: 4919]
95+
-h, --help Print help
96+
```
97+
98+
## iroh get
99+
```
100+
Fetch the data from the hash
101+
102+
Usage: iroh get [OPTIONS] --peer <PEER> --auth-token <AUTH_TOKEN> <HASH>
103+
104+
Arguments:
105+
<HASH> The root hash to retrieve
106+
107+
Options:
108+
-p, --peer <PEER> PeerId of the provider
109+
--auth-token <AUTH_TOKEN> The authentication token to present to the server
110+
-a, --addr <ADDR> Optional address of the provider, defaults to 127.0.0.1:4433
111+
-o, --out <OUT> Optional path to a new directory in which to save the file(s). If none is specified writes the data to STDOUT
112+
-h, --help
113+
```
114+
115+
116+
## iroh get-ticket
117+
```
118+
Fetches some data from a ticket,
119+
120+
The ticket contains all hash, authentication and connection information to connect to the provider. It is a simpler, but slightly less flexible alternative to the `get` subcommand.
121+
122+
Usage: iroh get-ticket [OPTIONS] <TICKET>
123+
124+
Arguments:
125+
<TICKET>
126+
Ticket containing everything to retrieve a hash from provider
127+
128+
Options:
129+
-o, --out <OUT>
130+
Optional path to a new directory in which to save the file(s). If none is specified writes the data to STDOUT
131+
132+
-h, --help
133+
Print help (see a summary with '-h')
134+
```
135+
136+
## iroh addresses
137+
```
138+
List addresses
139+
140+
Usage: iroh addresses [OPTIONS]
141+
142+
Options:
143+
--rpc-port <RPC_PORT> Optional rpc port, defaults to 4919 [default: 4919]
144+
-h, --help
145+
```
146+
147+

‎tailwindui-protocol/src/app/docs/install/page.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
3+
4+
# Installation
5+
6+
Iroh ships wuth a command line tool (CLI) that works on macOS, Linux & Windows.
7+
8+
## Installing Iroh
9+
Run this script to get started:
10+
```
11+
curl -fsSL https://sh.iroh.computer/install.sh | sh
12+
```
13+
14+
## Package Managers
15+
16+
Iroh is available on [tea](https://tea.xyz/) for macOS and Linux. To install, run:
17+
18+
```
19+
$ curl tea.xyz | sh
20+
# ^^ installs the tea package manager
21+
22+
$ iroh --help
23+
# ^^ tea installs iroh automagically
24+
```
25+
26+
## Building from Source
27+
Information about how to build from source can be found in our repo's [Developer documentation](https://github.com/n0-computer/iroh).
28+
29+
## Removing Iroh
30+
Iroh only caches data in `/tmp` directories, which are automatically purged when you restart your computer. To remove Iroh, remove the CLI binary.

‎tailwindui-protocol/src/app/docs/ipfs/page.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
3+
# Iroh and IPFS
4+
5+
Iroh is an IPFS _system_. It is not an implementation.
6+
7+
<Col>
8+
9+
</Col>
10+
<Col>
11+
12+
</Col>

‎tailwindui-protocol/src/app/docs/page.mdx‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ import { Resources } from '@/components/Resources'
33
import { HeroPattern } from '@/components/HeroPattern'
44

55
export const metadata = {
6-
title: 'API Documentation',
6+
title: 'Iroh Documentation',
77
description:
8-
'Learn everything there is to know about the Protocol API and integrate Protocol into your product.',
8+
'Learn about Iroh and how to integrate into your own project.',
99
}
1010

1111
export const sections = [
@@ -15,12 +15,13 @@ export const sections = [
1515

1616
<HeroPattern />
1717

18-
# API Documentation
18+
# Iroh Documentation
1919

20-
Use the Protocol API to access contacts, conversations, group messages, and more and seamlessly integrate your product into the workflows of dozens of devoted Protocol users. {{ className: 'lead' }}
20+
Iroh is a protocol for syncing bytes of any size, across any number of devices. Use iroh to build smarter, more efficient apps. {{ className: 'lead' }}
2121

2222
<div className="not-prose mb-16 mt-6 flex gap-3">
23-
<Button href="/docs/quickstart" arrow="right" children="Quickstart" />
23+
<Button href="/docs/install" arrow="right" children="Install" />
24+
<Button href="/docs/quickstart" children="Quickstart" />
2425
<Button href="/docs/sdks" variant="outline" children="Explore SDKs" />
2526
</div>
2627

@@ -30,10 +31,10 @@ To get started, create a new application in your [developer settings](#), then r
3031

3132
<div className="not-prose">
3233
<Button
33-
href="/sdks"
34+
href="/beta"
3435
variant="text"
3536
arrow="right"
36-
children="Get your API key"
37+
children="Join the beta"
3738
/>
3839
</div>
3940

‎tailwindui-protocol/src/app/favicon.ico‎

-12.2 KB
Binary file not shown.

‎tailwindui-protocol/src/components/Navigation.jsx‎

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -191,22 +191,29 @@ export const navigation = [
191191
links: [
192192
{ title: 'Introduction', href: '/docs' },
193193
{ title: 'Quickstart', href: '/docs/quickstart' },
194-
{ title: 'Overview', href: '/docs/overview' },
194+
{ title: 'Install', href: '/docs/install' },
195195
{ title: 'SDKs', href: '/docs/sdks' },
196-
{ title: 'Authentication', href: '/docs/authentication' },
197-
{ title: 'Pagination', href: '/docs/pagination' },
198-
{ title: 'IPFS', href: '/docs/ipfs' },
196+
{ title: 'Todo Example', href: '/docs/examples/todos' },
197+
{ title: 'File System Example', href: '/docs/examples/todos' },
198+
{ title: 'Airdrop Example', href: '/docs/examples/todos' },
199199
],
200200
},
201+
{ title: 'Concepts',
202+
links: [
203+
{ title: 'Overview', href: '/docs/overview' },
204+
{ title: 'Documents', href: '/docs/documents' },
205+
{ title: 'Blobs', href: '/docs/blobs' },
206+
{ title: 'Connections', href: '/docs/connections' },
207+
{ title: 'Anchors', href: '/docs/anchors' },
208+
{ title: 'IPFS', href: '/docs/ipfs' },
209+
]
210+
},
201211
{
202212
title: 'Resources',
203213
links: [
204214
{ title: 'Anchor HTTP API', href: '/docs/anchor-http-api'},
205-
{ title: 'Contacts', href: '/docs/contacts' },
206-
{ title: 'Conversations', href: '/docs/conversations' },
207-
{ title: 'Messages', href: '/docs/messages' },
208-
{ title: 'Groups', href: '/docs/groups' },
209-
{ title: 'Attachments', href: '/docs/attachments' },
215+
{ title: 'CLI', href: '/docs/cli' },
216+
{ title: 'REPL', href: '/docs/repl' },
210217
],
211218
}
212219
]

0 commit comments

Comments
 (0)