README.md in aptly_cli-0.1.4 vs README.md in aptly_cli-0.1.5
- old
+ new
@@ -16,13 +16,42 @@
$ bundle
Or install it yourself as:
$ gem install aptly_cli
+
+Create a configuration file with aptly server and port, /etc/aptly-cli.conf:
+
+ ---
+ :server: 127.0.0.1
+ :port: 8082
+
+If a configuration file is not found the defaults in the example configuration file above will be used
+
## Usage
+### aptly-cli version
+
+ NAME:
+
+ version
+
+ SYNOPSIS:
+
+ aptly-cli version
+
+ DESCRIPTION:
+
+ Display aptly server version
+
+ EXAMPLES:
+
+ # description
+ aptly-cli version
+
+
### aptly-cli file_list [options]
NAME:
file_list
@@ -131,20 +160,412 @@
Default distribution when publishing from this local repo
--default_component COMPONENT
Default component when publishing from this local repo
-### aptly-cli package [options]
-functions, fixtures, tests done. Need to add to bin/aptly-cli and document
+### aptly-cli repo_delete [options]
+ NAME:
+
+ repo_delete
+
+ SYNOPSIS:
+
+ aptly-cli repo_delete [options]
+
+ DESCRIPTION:
+
+ Delete a local repository, requires --name
+
+ EXAMPLES:
+
+ # description
+ aptly-cli repo_delete --name megatronsoftware
+
+ OPTIONS:
+
+ --name NAME
+ Local repository name, required
+
+ --force
+
+### aptly-cli repo_edit [options]
+
+ NAME:
+
+ repo_edit
+
+ SYNOPSIS:
+
+ aptly-cli repo_edit [options]
+
+ DESCRIPTION:
+
+ Edit a local repository metadata, requires --name
+
+ EXAMPLES:
+
+ # description
+ aptly-cli repo_edit --name megatronsoftware --default_distribution trusty
+
+ OPTIONS:
+
+ --name NAME
+ Local repository name, required
+
+ --comment COMMENT
+ Edit repository comment
+
+ --default_distribution DISTRIBUTION
+ Edit DefaultDistribution for repo
+
+ --default_component COMPONENT
+ Edit DefaultComponent for repo
+
+### aptly-cli repo_list [options]
+
+ NAME:
+
+ repo_list
+
+ SYNOPSIS:
+
+ aptly-cli repo_list [options]
+
+ DESCRIPTION:
+
+ Show list of currently available local repositories
+
+ EXAMPLES:
+
+ # description
+ aptly-cli repo_list
+
+
+### aptly-cli repo_package_query [options]
+
+ NAME:
+
+ repo_package_query
+
+ SYNOPSIS:
+
+ aptly-cli repo_package_query [options]
+
+ DESCRIPTION:
+
+ List all packages or search on repo contents, requires --name
+
+ EXAMPLES:
+
+ # description
+ aptly-cli repo_package_query --name megatronsoftware -query geoipupdate
+
+ OPTIONS:
+
+ --name NAME
+ Local repository name, required
+
+ --query QUERY
+ Package to query
+
+ --with_deps
+ Return results with dependencies
+
+ --format FORMAT
+ Format type to return, compact by default. "details" is an option
+
+### aptly-cli repo_show [options]
+
+ NAME:
+
+ repo_show
+
+ SYNOPSIS:
+
+ aptly-cli repo_show [options]
+
+ DESCRIPTION:
+
+ Returns basic information about local repository, require --name
+
+ EXAMPLES:
+
+ # description
+ aptly-cli repo_show --name megatronsoftware
+
+ OPTIONS:
+
+ --name NAME
+ Local repository name, required
+
+### aptly-cli repo_upload [options]
+
+ NAME:
+
+ repo_upload
+
+ SYNOPSIS:
+
+ aptly-cli repo_upload [options]
+
+ DESCRIPTION:
+
+ Import packages from files
+
+ EXAMPLES:
+
+ # description
+ aptly-cli repo_upload --name rocksoftware --dir rockpackages --noremove
+
+ OPTIONS:
+
+ --name NAME
+ Local repository name, required
+
+ --dir DIR
+ Directory where packages are stored via File API
+
+ --file FILE
+ Specific file to upload, if not provided the entire directory of files will be uploaded
+
+ --noremove
+ Flag to not remove any files that were uploaded via File API after repo upload
+
+ --forcereplace
+ flag to replace file(s) already in the repo
+
+### aptly-cli snapshot_create [options]
+
+ NAME:
+
+ snapshot_create
+
+ SYNOPSIS:
+
+ aptly-cli snapshot_create [options]
+
+ DESCRIPTION:
+
+ Create snapshot, require --name
+
+ EXAMPLES:
+
+ # Creating new snapshot megasoftware22-snap from megasoftware22 repo
+ aptly-cli snapshot_create --name megasoftware22-snap --repo meagsoftware22
+
+ OPTIONS:
+
+ --name NAME
+ Name of new snapshot, required
+
+ --repo REPO
+ Name of repo to snapshot
+
+ --description DESCRIPTION
+ Set description for snapshot
+
+### aptly-cli snapshot_delete [options]
+
+ NAME:
+
+ snapshot_delete
+
+ SYNOPSIS:
+
+ aptly-cli snapshot_delete [options]
+
+ DESCRIPTION:
+
+ Delete snapshot, require --name
+
+ EXAMPLES:
+
+ # Deleting the snapshot megasoftware22
+ aptly-cli snapshot_delete --name megatronsoftware22
+
+ # Deleting the snapshot megasoftware22 with force option
+ aptly-cli snapshot_delete --name megatronsoftware22 --force
+
+ OPTIONS:
+
+ --name NAME
+ Local snapshot name, required
+
+ --force
+ Force
+
+### aptly-cli snapshot_diff [options]
+
+ NAME:
+
+ snapshot_diff
+
+ SYNOPSIS:
+
+ aptly-cli snapshot_diff [options]
+
+ DESCRIPTION:
+
+ Calculate difference between two snapshots, require --name, require --withsnapshot
+
+ EXAMPLES:
+
+ # Show difference between megatronsoftware and rocksoftware snapshots
+ aptly-cli snapshot_diff --name megatronsoftware --withsnapshot rocksoftware
+
+ OPTIONS:
+
+ --name NAME
+ Local snapshot name (left)
+
+ --withsnapshot WITHSNAPSHOT
+ Snapshot to diff against (right)
+
+### aptly-cli snapshot_list [options]
+
+ NAME:
+
+ snapshot_list
+
+ SYNOPSIS:
+
+ aptly-cli snapshot_list [options]
+
+ DESCRIPTION:
+
+ Return list of all snapshots created in the system
+
+ EXAMPLES:
+
+ # Return list of all snapshots created in the system
+ aptly-cli snapshot_list
+
+ # Return list sorted by time
+ aptly-cli snapshot_list --sort time
+
+ OPTIONS:
+
+ --sort
+ Set sort by
+
+### aptly-cli snapshot_search [options]
+
+ NAME:
+
+ snapshot_search
+
+ SYNOPSIS:
+
+ aptly-cli snapshot_search [options]
+
+ DESCRIPTION:
+
+ List all packages in snapshot or perform search
+
+ EXAMPLES:
+
+ # List all packages in snapshot megasoftware22-snap
+ aptly-cli snapshot_search --name megasoftware22-snap
+
+ # List all packages in snapshot megasoftware22-snap with format set to details
+ aptly-cli snapshot_search --name megasoftware22-snap --format details
+
+ # Search for package called nginx in snapshot megasoftware22-snap
+ aptly-cli snapshot_search --name megasoftware22-snap --query nginx
+
+ OPTIONS:
+
+ --name NAME
+ Name of snapshot to search, required
+
+ --query QUERY
+ Specific package to query
+
+ --withdeps
+ Include package dependencies
+
+ --format FORMAT
+ Format the respone of the snapshot search results, compact by default.
+
+### aptly-cli snapshot_show [options]
+
+ NAME:
+
+ snapshot_show
+
+ SYNOPSIS:
+
+ aptly-cli snapshot_show [options]
+
+ DESCRIPTION:
+
+ Get information about snapshot by name., require --name
+
+ EXAMPLES:
+
+ # Show snapshot information for repo named megatronsoftware
+ aptly-cli snapshot_show --name megatronsoftware
+
+ OPTIONS:
+
+ --name NAME
+ Local snapshot name, required
+
+### aptly-cli snapshot_update [options]
+
+ NAME:
+
+ snapshot_update
+
+ SYNOPSIS:
+
+ aptly-cli snapshot_update [options]
+
+ DESCRIPTION:
+
+ Update snapshot’s description or name, require --name
+
+ EXAMPLES:
+
+ # Updating the snapshot megasoftware22 to a new name
+ aptly-cli snapshot_update --name megasoftware22 --new_name meagsoftware12-12-13
+
+ OPTIONS:
+
+ --name NAME
+ Local snapshot name, required
+
+ --new_name NEWNAME
+ New name for the snapshot
+
+ --description DESCRIPTION
+ Update description for snapshot
+
### aptly-cli graph [options]
-TODO
+ NAME:
-### aptly-cli version
+ graph
-TODO
+ SYNOPSIS:
+
+ aptly-cli graph [options]
+
+ DESCRIPTION:
+
+ Download an svg or png graph of repository layout
+
+ EXAMPLES:
+
+ # description
+ aptly-cli graph png > ~/repo_graph.png
+
+ OPTIONS:
+
+ --type GRAPH_TYPE
+ Type of graph to download, present options are png or svg
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.