Skip to content

Commit

Permalink
Add description for file CLI topic
Browse files Browse the repository at this point in the history
  • Loading branch information
garrettjstevens committed Aug 30, 2024
1 parent e9a0a56 commit b2ceb4e
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 20 deletions.
17 changes: 8 additions & 9 deletions packages/apollo-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ $ npm install -g @apollo-annotation/cli
$ apollo COMMAND
running command...
$ apollo (--version)
@apollo-annotation/cli/0.1.19 linux-x64 node-v18.20.3
@apollo-annotation/cli/0.1.19 linux-x64 node-v20.14.0
$ apollo --help [COMMAND]
USAGE
$ apollo COMMAND
Expand All @@ -32,22 +32,21 @@ USAGE

# Command Topics

- [`apollo assembly`](../website/docs/cli//assembly.md) - Commands to handle
- [`apollo assembly`](../website/docs/cli//assembly.md) - Commands to manage
assemblies
- [`apollo change`](../website/docs/cli//change.md) - Commands to handle the log
of changes made to the database
- [`apollo change`](../website/docs/cli//change.md) - Commands to manage the
change log
- [`apollo config`](../website/docs/cli//config.md) - Get or set apollo
configuration options
- [`apollo feature`](../website/docs/cli//feature.md) - Commands to handle
- [`apollo feature`](../website/docs/cli//feature.md) - Commands to manage
features
- [`apollo file`](../website/docs/cli//file.md) - Delete files from the Apollo
server
- [`apollo file`](../website/docs/cli//file.md) - Commands to manage files
- [`apollo help`](../website/docs/cli//help.md) - Display help for apollo.
- [`apollo login`](../website/docs/cli//login.md) - Login to Apollo
- [`apollo logout`](../website/docs/cli//logout.md) - Logout of Apollo
- [`apollo refseq`](../website/docs/cli//refseq.md) - Commands to handle
- [`apollo refseq`](../website/docs/cli//refseq.md) - Commands to manage
reference sequences
- [`apollo status`](../website/docs/cli//status.md) - View authentication status
- [`apollo user`](../website/docs/cli//user.md) - Commands to handle users
- [`apollo user`](../website/docs/cli//user.md) - Commands to manage users

<!-- commandsstop -->
13 changes: 8 additions & 5 deletions packages/apollo-cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,19 +45,22 @@
"topicSeparator": " ",
"topics": {
"assembly": {
"description": "Commands to handle assemblies"
"description": "Commands to manage assemblies"
},
"change": {
"description": "Commands to handle the log of changes made to the database"
"description": "Commands to manage the change log"
},
"feature": {
"description": "Commands to handle features"
"description": "Commands to manage features"
},
"refseq": {
"description": "Commands to handle reference sequences"
"description": "Commands to manage reference sequences"
},
"user": {
"description": "Commands to handle users"
"description": "Commands to manage users"
},
"file": {
"description": "Commands to manage files"
}
}
},
Expand Down
2 changes: 1 addition & 1 deletion packages/website/docs/cli/assembly.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `apollo assembly`

Commands to handle assemblies
Commands to manage assemblies

- [`apollo assembly add-fasta`](#apollo-assembly-add-fasta)
- [`apollo assembly add-file`](#apollo-assembly-add-file)
Expand Down
2 changes: 1 addition & 1 deletion packages/website/docs/cli/change.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `apollo change`

Commands to handle the log of changes made to the database
Commands to manage the change log

- [`apollo change get`](#apollo-change-get)

Expand Down
2 changes: 1 addition & 1 deletion packages/website/docs/cli/feature.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `apollo feature`

Commands to handle features
Commands to manage features

- [`apollo feature add-child`](#apollo-feature-add-child)
- [`apollo feature check`](#apollo-feature-check)
Expand Down
2 changes: 1 addition & 1 deletion packages/website/docs/cli/file.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `apollo file`

Delete files from the Apollo server
Commands to manage files

- [`apollo file delete`](#apollo-file-delete)
- [`apollo file download`](#apollo-file-download)
Expand Down
2 changes: 1 addition & 1 deletion packages/website/docs/cli/refseq.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `apollo refseq`

Commands to handle reference sequences
Commands to manage reference sequences

- [`apollo refseq add-alias`](#apollo-refseq-add-alias)
- [`apollo refseq get`](#apollo-refseq-get)
Expand Down
2 changes: 1 addition & 1 deletion packages/website/docs/cli/user.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `apollo user`

Commands to handle users
Commands to manage users

- [`apollo user get`](#apollo-user-get)

Expand Down

0 comments on commit b2ceb4e

Please sign in to comment.