Skip to content

Commit 49de863

Browse files
committed
Document --timeout option for fedify lookup
Add documentation for the -T/--timeout option in the CLI documentation, explaining how to set request timeout for network operations. Also update CHANGES.md to reference PR #372.
1 parent fc3e475 commit 49de863

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

CHANGES.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,10 +163,11 @@ To be released.
163163
- Added `-T`/`--timeout` option to `fedify lookup` command. This option allows
164164
users to specify timeout in seconds for network requests to prevent
165165
hanging on slow or unresponsive servers.
166-
[[#258] by Hyunchae Kim]
166+
[[#258], [#372] by Hyunchae Kim]
167167

168168
[#353]: https://github.com/fedify-dev/fedify/issues/353
169169
[#365]: https://github.com/fedify-dev/fedify/pull/365
170+
[#372]: https://github.com/fedify-dev/fedify/pull/372
170171

171172
### @fedify/amqp
172173

docs/cli.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -829,6 +829,19 @@ about the specified objects to a given path, run the command below:
829829
fedify lookup -o actors.json @[email protected] @[email protected]
830830
~~~~
831831

832+
### `-T`/`--timeout`: Request timeout
833+
834+
*This option is available since Fedify 1.9.0.*
835+
836+
You can specify the request timeout duration by using the `-T`/`--timeout`
837+
option. The duration should be an integer in seconds. By default, there is no
838+
timeout. For example, to set the request timeout to 10 seconds, run the below
839+
command:
840+
841+
~~~~ sh
842+
fedify lookup --timeout 10 @[email protected]
843+
~~~~
844+
832845

833846
`fedify inbox`: Ephemeral inbox server
834847
--------------------------------------

0 commit comments

Comments
 (0)