Skip to content

Commit 296dd79

Browse files
update doc
Signed-off-by: Laurent Martin <laurent.martin.l@gmail.com>
1 parent 12f159d commit 296dd79

2 files changed

Lines changed: 11 additions & 59 deletions

File tree

docs/README.erb.md

Lines changed: 5 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -246,39 +246,15 @@ Recommended Workflow:
246246
Example Prompt:
247247

248248
```text
249-
Strictly using only the attached manual for <%=cmd%> for that version, please generate a command to send a package via Aspera on Cloud using the Bash shell.
250-
251-
Requirements:
252-
253-
- Set a custom title and note.
254-
- Define specific recipients.
255-
- Cap the transfer speed at 300Mbps.
249+
Strictly using only the attached manual for <%=cmd%> for that version.
250+
Generate a command to send a package via Aspera on Cloud using the Bash shell.
251+
Set a custom title and note.
252+
Define specific recipients.
253+
Cap the transfer speed at 300Mbps.
256254
```
257255

258256
By providing the documentation as a direct reference, you reduce "hallucinations" and receive accurate, executable commands in seconds.
259257

260-
### Get help from a "friend"
261-
262-
You probably have an AI Friend.
263-
Use it to build and ask about <%=tool%>.
264-
A straightforward way is to do the following:
265-
266-
- Download the Manual as Markdown (README.md) from the GitHub repository.
267-
- Open your AI assistant, and attach that file to the new prompt.
268-
- Ask your question:
269-
270-
> [!NOTE]
271-
> It's better to specify your environment, especially the shell.
272-
> For example, if on Windows, specify if you are using `cmd`, **PowerShell** 5, or **PowerShell** 7, as quoting rules differ.
273-
274-
```text
275-
Based on the user manual of ascli, please create a command line to run on bash shell to send a package using Aspera on Cloud.
276-
I need to set the title, a note and recipients.
277-
I want also to set the speed of transfer to 300Mbps.
278-
```
279-
280-
- Engage into the conversation, and you'll get results very rapidly.
281-
282258
### Next Steps
283259

284260
- Learn the CLI: Read [Command Line Interface](#command-line-interface) to understand configuration, options, and commands.

docs/README.md

Lines changed: 6 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -247,39 +247,15 @@ Recommended Workflow:
247247
Example Prompt:
248248

249249
```text
250-
Strictly using only the attached manual for ascli for that version, please generate a command to send a package via Aspera on Cloud using the Bash shell.
251-
252-
Requirements:
253-
254-
- Set a custom title and note.
255-
- Define specific recipients.
256-
- Cap the transfer speed at 300Mbps.
250+
Strictly using only the attached manual for ascli for that version.
251+
Generate a command to send a package via Aspera on Cloud using the Bash shell.
252+
Set a custom title and note.
253+
Define specific recipients.
254+
Cap the transfer speed at 300Mbps.
257255
```
258256

259257
By providing the documentation as a direct reference, you reduce "hallucinations" and receive accurate, executable commands in seconds.
260258

261-
### Get help from a "friend"
262-
263-
You probably have an AI Friend.
264-
Use it to build and ask about `ascli`.
265-
A straightforward way is to do the following:
266-
267-
- Download the Manual as Markdown (README.md) from the GitHub repository.
268-
- Open your AI assistant, and attach that file to the new prompt.
269-
- Ask your question:
270-
271-
> [!NOTE]
272-
> It's better to specify your environment, especially the shell.
273-
> For example, if on Windows, specify if you are using `cmd`, **PowerShell** 5, or **PowerShell** 7, as quoting rules differ.
274-
275-
```text
276-
Based on the user manual of ascli, please create a command line to run on bash shell to send a package using Aspera on Cloud.
277-
I need to set the title, a note and recipients.
278-
I want also to set the speed of transfer to 300Mbps.
279-
```
280-
281-
- Engage into the conversation, and you'll get results very rapidly.
282-
283259
### Next Steps
284260

285261
- Learn the CLI: Read [Command Line Interface](#command-line-interface) to understand configuration, options, and commands.
@@ -4899,7 +4875,7 @@ OPTIONS: global
48994875
--bash-comp Generate bash completion for command
49004876
--show-config Display parameters used for the provided action
49014877
-v, --version Display version
4902-
--ui=ENUM Method to start browser: graphical, [text]
4878+
--ui=ENUM Method to start browser: [graphical], text
49034879
--invalid-characters=VALUE Replacement character and invalid filename characters
49044880
--log-level=ENUM Log level: debug, error, fatal, [info], trace1, trace2, unknown, warn
49054881
--log-format=VALUE Log formatter (Proc, Logger::Formatter)

0 commit comments

Comments
 (0)