Skip to content

Commit 4df19a6

Browse files
authored
Readme and completions fixups (#165)
* Improve formatting of readme for new cost commands * Add forgotten "update-server" command to completions * Add completions/reload.sh script to help developing zsh completions
1 parent 90a5f53 commit 4df19a6

File tree

3 files changed

+18
-10
lines changed

3 files changed

+18
-10
lines changed

README.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -99,15 +99,14 @@ requires `column`, `curl`, `mail`, and [jq](https://stedolan.github.io/jq/)
9999
* `update-server`
100100
* Change the cromwell server that new jobs will be submitted to.
101101

102-
#### Get cost for a workflow
103-
* `cost`
104-
* Get the cost for a workflow.
105-
* Will only work for workflows that completed more than 8 hours ago on GCS.
106-
* Requires the `gcp_bq_cost_table.config` configuration file to exist and contain the big query cost table for your organization.
107-
* `cost-detailed`
108-
* Get the cost for a workflow at the task level.
109-
* Will only work for workflows that completed more than 8 hours ago on GCS.
110-
* Requires the `gcp_bq_cost_table.config` configuration file to exist and contain the big query cost table for your organization.
102+
#### Get cost of a workflow
103+
Costs are only available for workflows that completed more than 8 hours ago on a `GCS` backend.
104+
Requires the `~/.cromshell/gcp_bq_cost_table.config` configuration file to exist and contain the name of the BigQuery cost table for your organization.
105+
* `cost [workflow-id] [[workflow-id]...]`
106+
* Get the cost for a workflow.
107+
* `cost-detailed [workflow-id] [[workflow-id]...]`
108+
* Get the cost for a workflow at the task level.
109+
111110

112111
### Features:
113112
* Running `submit` will create a new folder in the `~/.cromshell/${CROMWELL_URL}/` directory named with the cromwell job id of the newly submitted job.

completions/_cromshell

+2-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ function _cromshell {
2424
list\:'Display a list jobs submitted through cromshell'
2525
cleanup\:'Clean up local cached list'
2626
cost\:'Display workflow cost'
27-
cost-detailed\:'Display detailed workflow cost'
27+
cost-detailed\:'Display workflow cost broken down by task'
28+
update-server\:'Change the cromshell server new jobs will be submited to'
2829
))" \
2930
"*::arg:->args"
3031

completions/reload.sh

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Reload the _cromshell completion file for testing
2+
# Usage:
3+
# source reload.sh
4+
5+
fpath=($PWD $fpath)
6+
unfunction _cromshell
7+
autoload -U compinit
8+
compinit

0 commit comments

Comments
 (0)