22<!--
33DO NOT EDIT: THIS FILE IS GENERATED, edit docs/README.erb.md.
44PANDOC_META_BEGIN
5- subtitle: "ascli 4.26.0.pre "
5+ subtitle: "ascli 4.25.3 "
66author: "Laurent Martin"
77PANDOC_META_END
88-->
@@ -40,7 +40,7 @@ Need to debug? I’ll show you what’s going on under the hood.
4040
4141Think of me as Aspera’s command-line sidekick: quick, reliable, and a little no-nonsense. You bring the files; I’ll bring the horsepower."
4242
43- Version: 4.26.0.pre
43+ Version: 4.25.3
4444
4545Laurent Martin/2016-2026
4646
@@ -124,7 +124,7 @@ ascli --version
124124```
125125
126126``` text
127- 4.26.0.pre
127+ 4.25.3
128128```
129129
130130> [ !NOTE]
@@ -786,11 +786,11 @@ Necessary gems can be packed in a `tar.gz` like this:
786786
787787``` bash
788788mkdir temp_folder
789- gem install aspera-cli:4.26.0.pre --no-document --install-dir temp_folder
789+ gem install aspera-cli:4.25.3 --no-document --install-dir temp_folder
790790find temp_folder
791- mv temp_folder/cache aspera-cli-4.26.0.pre -gems
791+ mv temp_folder/cache aspera-cli-4.25.3 -gems
792792rm -fr temp_folder
793- tar zcvf aspera-cli-4.26.0.pre -gems aspera-cli-4.26.0.pre -gems.tgz
793+ tar zcvf aspera-cli-4.25.3 -gems aspera-cli-4.25.3 -gems.tgz
794794```
795795
796796#### Unix-like
@@ -935,7 +935,7 @@ ascli -v
935935```
936936
937937``` text
938- 4.26.0.pre
938+ 4.25.3
939939```
940940
941941In order to keep persistency of configuration on the host, you should specify your user's configuration folder as a volume for the container.
@@ -4654,7 +4654,7 @@ ascli server upload "faux:///mydir?file=testfile&count=1000&size=1" --to-folder=
46544654```text
46554655ascli -h
46564656NAME
4657- ascli -- a command line tool for Aspera Applications (v4.26.0.pre )
4657+ ascli -- a command line tool for Aspera Applications (v4.25.3 )
46584658
46594659SYNOPSIS
46604660 ascli COMMANDS [OPTIONS] [ARGS]
@@ -4699,7 +4699,7 @@ OPTIONS: global
46994699 --bash-comp Generate bash completion for command
47004700 --show-config Display parameters used for the provided action
47014701 -v, --version Display version
4702- --ui=ENUM Method to start browser: [ graphical], text
4702+ --ui=ENUM Method to start browser: graphical, [ text]
47034703 --invalid-characters=VALUE Replacement character and invalid filename characters
47044704 --log-level=ENUM Log level: debug, error, fatal, [info], trace1, trace2, unknown, warn
47054705 --log-format=VALUE Log formatter (Proc, Logger::Formatter)
@@ -4842,7 +4842,7 @@ OPTIONS:
48424842 --redirect-uri=VALUE OAuth (Web) redirect URI for web authentication
48434843 --private-key=VALUE OAuth (JWT) RSA private key PEM value (prefix file path with @file:)
48444844 --passphrase=VALUE OAuth (JWT) RSA private key passphrase
4845- --box=VALUE Package inbox, either shared inbox name or one of: inbox, inbox_history, inbox_all, inbox_all_history, outbox, outbox_history, pending, pending_history, all or ALL
4845+ --box=VALUE Package inbox, either shared inbox name or one of: inbox, inbox_history, inbox_all, inbox_all_history, pending, pending_history, all, outbox, outbox_history or ALL
48464846 --shared-folder=VALUE Send package with files from shared folder
48474847 --group-type=ENUM Type of shared box: [shared_inboxes], workgroups
48484848
@@ -6446,7 +6446,7 @@ For instructions, refer to section `find` for plugin `node`.
64466446
64476447```shell
64486448admin analytics application_events
6449- admin analytics files organization ' ' aoc_transfer_id
6449+ admin analytics files organization ' ' ' $( read_value_from : aoc_transfer_id) '
64506450admin analytics transfers organization --query=@json:' {" status" :" completed" ," direction" :" receive" ," limit" :2}' --notify-to=my_email_external --notify-template=@ruby:' %Q{From: < %=from_name%> << %=from_email%>>\nTo: <<%=to%>>\nSubject: <%=ev["files_completed"]%> files received\n\n<%=ev.to_yaml%>}'
64516451admin analytics transfers users --once-only=yes
64526452admin application list
@@ -6464,7 +6464,7 @@ admin bearer_token --display=data
64646464admin client list
64656465admin client_access_key list
64666466admin client_registration_token create @json:'{"data":{"name":"test_client_reg1","client_subject_scopes":["alee","aejd"],"client_subject_enabled":true}}'
6467- admin client_registration_token delete client_reg_id
6467+ admin client_registration_token delete ' $( read_value_from : client_reg_id) '
64686468admin client_registration_token list
64696469admin contact list
64706470admin dropbox list
@@ -6502,12 +6502,12 @@ admin user modify %name:my_user_email @json:'{"deactivated":false}'
65026502admin workspace dropbox %name:my_other_workspace list
65036503admin workspace list
65046504admin workspace shared_folder %name:my_other_workspace list
6505- admin workspace shared_folder %name:my_other_workspace member shared_folder_id list
6505+ admin workspace shared_folder %name:my_other_workspace member ' $( read_value_from : shared_folder_id) ' list
65066506admin workspace_membership list
65076507admin workspace_membership list --fields=ALL --query=@json:'{"page":1,"per_page":50,"embed":"member","inherited":false,"workspace_id":11363,"sort":"name"}'
6508- automation workflow action wf_id create @json:'{"name":"toto"}'
6508+ automation workflow action ' $( read_value_from : wf_id) ' create @json:'{"name":"toto"}'
65096509automation workflow create @json:'{"name":"test_workflow"}'
6510- automation workflow delete wf_id
6510+ automation workflow delete ' $( read_value_from : wf_id) '
65116511automation workflow list
65126512automation workflow list --query=@json:'{"show_org_workflows":"true"}'
65136513automation workflow list --select=@json:'{"name":"test_workflow"}' --fields=id
@@ -6536,8 +6536,8 @@ files rename /some_folder testdst
65366536files short_link /testdst private create
65376537files short_link /testdst private list
65386538files short_link /testdst public create @: access_levels=upload --fields=id
6539- files short_link /testdst public modify aoc_short_link_pub_create @: access_levels=edit
6540- files show %id:aoc_file_id
6539+ files short_link /testdst public modify ' $( read_value_from : aoc_short_link_pub_create) ' @: access_levels=edit
6540+ files show ' %id:$( read_value_from : aoc_file_id) '
65416541files show /
65426542files show testdst/test_file.bin
65436543files sync admin status /data/local_sync
@@ -6553,14 +6553,14 @@ gateway @json:'{"url":"https://localhost:12346/aspera/faspex"}'
65536553organization
65546554organization --format=image --fields=background_image_url --ui=text
65556555organization --url=my_public_link_recv_from_aoc_user
6556- packages browse package_id3 /
6556+ packages browse ' $( read_value_from : package_id3) ' /
65576557packages list
65586558packages list --query=@json:'{"dropbox_name":"my_shared_inbox_name","sort":"-received_at","archived":false,"received":true,"has_content":true,"exclude_dropbox_packages":false}'
6559+ packages receive '$( read_value_from :package_id3) ' --to-folder=.
6560+ packages receive '$( read_value_from :package_id3) ' --to-folder=. /
65596561packages receive ALL --once-only=yes --to-folder=. --lock-port=50101 --package-folder.fld.0=name --package-folder.fld.1=id --package-folder.opt=true
65606562packages receive ALL --once-only=yes --to-folder=. --lock-port=50101 --query=@json:'{"dropbox_name":"my_shared_inbox_name","archived":false,"received":true,"has_content":true,"exclude_dropbox_packages":false,"include_draft":false}' --ts=@json:'{"resume_policy":"sparse_csum","target_rate_kbps":50000}'
65616563packages receive INIT --once-only=yes --query.dropbox_name=my_shared_inbox_name
6562- packages receive package_id3 --to-folder=.
6563- packages receive package_id3 --to-folder=. /
65646564packages send --workspace=my_workspace_shared_inbox --validate-metadata=yes @json:'{"name":"$( name) $( TIMESTEMP_TEST_RUN) ","recipients":["my_shared_inbox_meta"],"metadata":[{"input_type":"single-text","name":"Project Id","values":["123"]},{"input_type":"single-dropdown","name":"Type","values":["Opt2"]},{"input_type":"multiple-checkbox","name":"CheckThose","values":["Check1","Check2"]},{"input_type":"date","name":"Optional Date","values":["2021-01-13T15:02:00.000Z"]}]}' test_file.bin
65656565packages send --workspace=my_workspace_shared_inbox --validate-metadata=yes @json:'{"name":"$( name) $( TIMESTEMP_TEST_RUN) ","recipients":["my_shared_inbox_meta"],"metadata":{"Project Id":"456","Type":"Opt2","CheckThose":["Check1","Check2"],"Optional Date":"2021-01-13T15:02:00.000Z"}}' test_file.bin
65666566packages send --workspace=my_workspace_shared_inbox @json:'{"name":"$( name) $( TIMESTEMP_TEST_RUN) ","recipients":["my_shared_inbox_name"]}' test_file.bin
@@ -6765,7 +6765,7 @@ ascli server --url=ssh://hsts.example.com:33001 --username=john --ssh-keys=~/.ss
67656765
67666766` ` ` shell
67676767browse /
6768- browse / --password=@none: --ssh-options=@json:'{"number_of_password_prompts":0}' --ssh-keys=serv_key_path
6768+ browse / --password=@none: --ssh-options=@json:'{"number_of_password_prompts":0}' --ssh-keys=' $( read_value_from : serv_key_path) '
67696769browse my_inside_folder/test_file.bin
67706770browse my_upload_folder/target_hot
67716771cp my_inside_folder/test_file.bin my_upload_folder/200KB.2
@@ -7340,7 +7340,7 @@ ascli node -N --url=https://... --password="Bearer $(cat bearer.txt)" --root-id=
73407340> Add ` ascli node` in front of the following commands:
73417341
73427342` ` ` shell
7343- --url=https://tst.example.com/path --password=' Bearer node_bearer_token' --root-id=bearer_root_id access_key do self browse /
7343+ --url=https://tst.example.com/path --password=' Bearer $(read_value_from : node_bearer_token) ' --root-id=' $(read_value_from : bearer_root_id) ' access_key do self browse /
73447344access_key create @json:' {"id":"my_username","secret":"my_password_here","storage":{"type":"local","path":"/"}}'
73457345access_key delete my_username
73467346access_key do my_ak_name browse / --secret=my_ak_secret
@@ -7358,7 +7358,7 @@ access_key do my_ak_name node_info / --secret=my_ak_secret
73587358access_key do my_ak_name rename /tst_nd_ak test_nd_ak2 --secret=my_ak_secret
73597359access_key do my_ak_name show %id:1 --secret=my_ak_secret
73607360access_key do my_ak_name upload ' faux:///test_nd_ak3?100k' --default-ports=no --secret=my_ak_secret
7361- access_key do self permission %id:bearer_root_id create @json:' {"access_type":"user","access_id":"666"}'
7361+ access_key do self permission ' %id:$(read_value_from : bearer_root_id) ' create @json:' {"access_type":"user","access_id":"666"}'
73627362access_key do self permission / delete 1
73637363access_key do self permission / show 1
73647364access_key list
@@ -7413,12 +7413,12 @@ sync admin status /data/local_sync
74137413sync pull /aspera-test-dir-tiny --to-folder=/data/local_sync @json:' {"name":"my_sync_session_name","reset":true}'
74147414sync pull /aspera-test-dir-tiny --to-folder=/data/local_sync @json:' {"reset":true}'
74157415transfer bandwidth_average
7416- transfer cancel nd_xfer_id
7416+ transfer cancel ' $(read_value_from : nd_xfer_id) '
74177417transfer list --query=@json:' {"active_only":true}'
74187418transfer list --query=@json:' {"reset":true}' --once-only=yes
7419- transfer modify nd_xfer_id @json:' {"target_rate_kbps":10000}'
7419+ transfer modify ' $(read_value_from : nd_xfer_id) ' @json:' {"target_rate_kbps":10000}'
74207420transfer sessions
7421- transfer show nd_xfer_id
7421+ transfer show ' $(read_value_from : nd_xfer_id) '
74227422transport
74237423upload ' faux:///testfile1?1m' --to-folder=my_local_path
74247424upload --to-folder=my_upload_folder --sources=@ts --ts=@json:' {"paths":[{"source":"/aspera-test-dir-small/10MB.2"}],"precalculate_job_size":true}' --transfer=node --transfer-info=@json:' {"url":"https://node.example.com/path@","username":"my_username","password":"my_password_here"}'
@@ -7707,29 +7707,29 @@ gateway @json:'{"url":"https://localhost:12346/aspera/faspex"}'
77077707health --url=https://faspex5.example.com/path
77087708invitation list
77097709invitations create @json:' {" email_address" :" aspera.user1+u@gmail.com" }'
7710- packages browse f5_package_id --query=@json:' {" recursive" :true}'
7711- packages delete f5_package_id
7710+ packages browse ' $( read_value_from : f5_package_id) ' --query=@json:' {" recursive" :true}'
7711+ packages delete ' $( read_value_from : f5_package_id) '
77127712packages list --box=ALL
77137713packages list --box=my_shared_box_name
77147714packages list --box=my_workgroup --group-type=workgroups
77157715packages list --box=outbox --fields=DEF,sender.email,recipients.0.recipient_type
77167716packages list --query=@json:' {" mailbox" :" inbox" ," status" :" completed" }'
7717- packages receive --box=my_shared_box_name f5_pack_shboxc --to-folder=.
7718- packages receive --box=my_workgroup --group-type=workgroups workgroup_package_id1 --to-folder=.
7717+ packages receive ' $( read_value_from :f5_package_id) ' --to-folder=. --ts=@json:' {" content_protection_password" :" my_secret_here" }'
7718+ packages receive --box=my_shared_box_name ' $( read_value_from :f5_pack_shboxc) ' --to-folder=.
7719+ packages receive --box=my_workgroup --group-type=workgroups ' $( read_value_from :workgroup_package_id1) ' --to-folder=.
77197720packages receive ALL --once-only=yes --to-folder=.
77207721packages receive INIT --once-only=yes
7721- packages receive f5_package_id --to-folder=. --ts=@json:' {" content_protection_password" :" my_secret_here" }'
77227722packages send --url=my_public_link_send_f5_user @json:' {" title" :" test title" }' test_file.bin
77237723packages send --url=my_public_link_send_shared_box @json:' {" title" :" test title" }' test_file.bin
77247724packages send @json:' {" title" :" test title" ," recipients" :[" my_shared_box_name" ]," metadata" :{" Options" :" Opt1" ," TextInput" :" example text" }}' test_file.bin
77257725packages send @json:' {" title" :" test title" ," recipients" :[" my_workgroup" ]}' test_file.bin
77267726packages send @json:' {" title" :" test title" ," recipients" :[{" name" :" my_username" }]my_meta}' test_file.bin --ts=@json:' {" content_protection_password" :" my_secret_here" }'
77277727packages send @json:' {" title" :" test_webhook_ascli" ," recipients" :[" my_shared_box_name" ]}' ' faux:///test1? 1m'
7728- packages show --box=my_shared_box_name f5_pack_shboxc
7729- packages show --box=my_workgroup --group-type=workgroups workgroup_package_id1
7730- packages show f5_package_id
7731- packages status f5_p3a @list:,failed,completed
7732- packages status f5_package_id
7728+ packages show ' $( read_value_from :f5_package_id ) '
7729+ packages show --box=my_shared_box_name ' $( read_value_from :f5_pack_shboxc ) '
7730+ packages show --box=my_workgroup --group-type=workgroups ' $( read_value_from :workgroup_package_id1 ) '
7731+ packages status ' $( read_value_from : f5_p3a) ' @list:,failed,completed
7732+ packages status ' $( read_value_from : f5_package_id) '
77337733postprocessing @json:' {" url" :" https://localhost:8553/asclihook" ," script_folder" :" $( PATH_SCRIPTS) " ," cert" :" $( TMP / " localhost.p12" ) " ," key" :" changeit" }'
77347734shared browse %name:my_src
77357735shared list
@@ -8362,12 +8362,12 @@ health
83628362login_methods
83638363me
83648364package list --query.max=5
8365+ package receive ' $(read_value_from :f4_package_id)' --to-folder=.
8366+ package receive ' $(read_value_from :f4_package_id2)' --to-folder=. --box=sent
8367+ package receive ' $(read_value_from :f4_package_id3)' --to-folder=.
8368+ package receive ' $(read_value_from :f4_package_id4)' --recipient=' *my_dbx' --to-folder=.
8369+ package receive ' $(read_value_from :f4_package_id5)' --recipient=' *my_wkg' --to-folder=.
83658370package receive ALL --once-only=yes --to-folder=. --query.max=10
8366- package receive f4_package_id --to-folder=.
8367- package receive f4_package_id2 --to-folder=. --box=sent
8368- package receive f4_package_id3 --to-folder=.
8369- package receive f4_package_id4 --recipient=' *my_dbx' --to-folder=.
8370- package receive f4_package_id5 --recipient=' *my_wkg' --to-folder=.
83718371package send --delivery-info=@json:' {"title":"$(name) $(TIMESTEMP_TEST_RUN)","recipients":["my_email_internal","my_username"]}' test_file.bin
83728372package send --delivery-info=@json:' {"title":"$(name) $(TIMESTEMP_TEST_RUN)","recipients":["my_email_internal"]}' --remote-source=%name:my_src sample_source.txt
83738373package send --delivery-info=@json:' {"title":"$(name) $(TIMESTEMP_TEST_RUN)","recipients":[*my_dbx]}' test_file.bin
@@ -8508,10 +8508,10 @@ workflow status ALL
85088508workflow status my_workflow_id
85098509workflow workorders my_workflow_id
85108510workflow workorders my_workflow_id --fields=id --query.max_results=1
8511- workorder cancel orch_workorder_id
8512- workorder output orch_workorder_id
8513- workorder reset orch_workorder_id
8514- workorder status orch_workorder_id
8511+ workorder cancel ' $( read_value_from : orch_workorder_id) '
8512+ workorder output ' $( read_value_from : orch_workorder_id) '
8513+ workorder reset ' $( read_value_from : orch_workorder_id) '
8514+ workorder status ' $( read_value_from : orch_workorder_id) '
85158515workstep cancel 1
85168516workstep status 1
85178517```
@@ -8670,7 +8670,7 @@ Using `ascli`, you can remotely create and manage bridges on faspio Gateway, sim
86708670
86718671```shell
86728672bridges create @json:' {" name" :" test1" ," local" :{" protocol" :" tcp" ," tls_enabled" :false," port" :" 3000" ," bind_address" :" 127.0.0.1" }," forward" :{" protocol" :" fasp" ," tls_enabled" :false," port" :" 3994" ," bind_address" :" 127.0.0.1" ," host" :[" 10.0.0.1" ]}}'
8673- bridges delete --bulk=yes @json:faspio_bclean_list
8673+ bridges delete --bulk=yes @json:' $( read_value_from : faspio_bclean_list) '
86748674bridges list
86758675health
86768676```
0 commit comments