conjur-cli 6.0.1 → 6.2.3

data/NOTICES.txt

@@ -0,0 +1,421 @@
+=============== TABLE OF CONTENTS =============================
+
+The following is a listing of the Conjur Service Broker open source components detailed
+in this document. This list is provided for your convenience; please read
+further if you wish to review the copyright notice(s) and the full text
+of the license associated with each component.
+
+
+SECTION 1: Apache-2.0 
+
+>>> https://rubygems.org/gems/conjur-api/versions/5.3.4
+>>> https://rubygems.org/gems/gli/versions/2.19.2
+
+SECTION 2: BSD-2-Clause
+
+>>> https://rubygems.org/gems/highline/versions/1.7.10
+>>> https://rubygems.org/gems/xdg/versions/2.2.3
+
+SECTION 3: MIT 
+
+>>> https://rubygems.org/gems/activesupport/versions/5.2.4.4
+>>> https://rubygems.org/gems/deep_merge/versions/1.0.1
+>>> https://rubygems.org/gems/netrc/versions/0.10.3
+>>> https://rubygems.org/gems/table_print/versions/1.5.7
+
+APPENDIX: Standard License Files and Templates
+
+>>> Apache-2.0
+
+>>> BSD-2-Clause
+
+>>> MIT
+
+--------------- SECTION 1: Apache-2.0 ----------
+
+Apache-2.0 License is applicable to the following component(s).
+
+>>> https://rubygems.org/gems/conjur-api/versions/5.3.4
+
+Copyright (c) 2020 CyberArk Software Ltd. All rights reserved.'
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+>>> https://rubygems.org/gems/gli/versions/2.19.2
+
+Copyright (c) 2010 by Dave Copeland
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+--------------- SECTION 2: BSD-2-Clause ----------
+
+>>> https://rubygems.org/gems/highline/versions/1.7.10
+
+Copyright 2005 Gray Productions. All rights reserved.
+
+>>> https://rubygems.org/gems/xdg/versions/2.2.3
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+--------------- SECTION 3: MIT ----------
+
+MIT License is applicable to the following component(s).
+
+>>> https://rubygems.org/gems/activesupport/versions/5.2.4.4
+
+Copyright (c) 2005-2018 David Heinemeier Hansson'
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
+>>> https://rubygems.org/gems/deep_merge/versions/1.0.1
+
+Copyright (c) 2008-2104 Steve Midgley, Daniel DeLeo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+>>> https://rubygems.org/gems/netrc/versions/0.10.3
+
+Copyright (c) 2011-2014 CONTRIBUTORS.md
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+>>> https://rubygems.org/gems/table_print/versions/1.5.7
+
+Copyright (c) 2012-2016 Chris Doyle
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+=============== APPENDIX: License Files and Templates ==============
+
+
+
+--------------- APPENDIX 1: Apache-2.0 License (Template) -----------
+
+                             Apache License
+                       Version 2.0, January 2004
+                    http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+  "License" shall mean the terms and conditions for use, reproduction,
+  and distribution as defined by Sections 1 through 9 of this document.
+
+  "Licensor" shall mean the copyright owner or entity authorized by
+  the copyright owner that is granting the License.
+
+  "Legal Entity" shall mean the union of the acting entity and all
+  other entities that control, are controlled by, or are under common
+  control with that entity. For the purposes of this definition,
+  "control" means (i) the power, direct or indirect, to cause the
+  direction or management of such entity, whether by contract or
+  otherwise, or (ii) ownership of fifty percent (50%) or more of the
+  outstanding shares, or (iii) beneficial ownership of such entity.
+
+  "You" (or "Your") shall mean an individual or Legal Entity
+  exercising permissions granted by this License.
+
+  "Source" form shall mean the preferred form for making modifications,
+  including but not limited to software source code, documentation
+  source, and configuration files.
+
+  "Object" form shall mean any form resulting from mechanical
+  transformation or translation of a Source form, including but
+  not limited to compiled object code, generated documentation,
+  and conversions to other media types.
+
+  "Work" shall mean the work of authorship, whether in Source or
+  Object form, made available under the License, as indicated by a
+  copyright notice that is included in or attached to the work
+  (an example is provided in the Appendix below).
+
+  "Derivative Works" shall mean any work, whether in Source or Object
+  form, that is based on (or derived from) the Work and for which the
+  editorial revisions, annotations, elaborations, or other modifications
+  represent, as a whole, an original work of authorship. For the purposes
+  of this License, Derivative Works shall not include works that remain
+  separable from, or merely link (or bind by name) to the interfaces of,
+  the Work and Derivative Works thereof.
+
+  "Contribution" shall mean any work of authorship, including
+  the original version of the Work and any modifications or additions
+  to that Work or Derivative Works thereof, that is intentionally
+  submitted to Licensor for inclusion in the Work by the copyright owner
+  or by an individual or Legal Entity authorized to submit on behalf of
+  the copyright owner. For the purposes of this definition, "submitted"
+  means any form of electronic, verbal, or written communication sent
+  to the Licensor or its representatives, including but not limited to
+  communication on electronic mailing lists, source code control systems,
+  and issue tracking systems that are managed by, or on behalf of, the
+  Licensor for the purpose of discussing and improving the Work, but
+  excluding communication that is conspicuously marked or otherwise
+  designated in writing by the copyright owner as "Not a Contribution."
+
+  "Contributor" shall mean Licensor and any individual or Legal Entity
+  on behalf of whom a Contribution has been received by Licensor and
+  subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  copyright license to reproduce, prepare Derivative Works of,
+  publicly display, publicly perform, sublicense, and distribute the
+  Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  (except as stated in this section) patent license to make, have made,
+  use, offer to sell, sell, import, and otherwise transfer the Work,
+  where such license applies only to those patent claims licensable
+  by such Contributor that are necessarily infringed by their
+  Contribution(s) alone or by combination of their Contribution(s)
+  with the Work to which such Contribution(s) was submitted. If You
+  institute patent litigation against any entity (including a
+  cross-claim or counterclaim in a lawsuit) alleging that the Work
+  or a Contribution incorporated within the Work constitutes direct
+  or contributory patent infringement, then any patent licenses
+  granted to You under this License for that Work shall terminate
+  as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+  Work or Derivative Works thereof in any medium, with or without
+  modifications, and in Source or Object form, provided that You
+  meet the following conditions:
+
+  (a) You must give any other recipients of the Work or
+      Derivative Works a copy of this License; and
+
+  (b) You must cause any modified files to carry prominent notices
+      stating that You changed the files; and
+
+  (c) You must retain, in the Source form of any Derivative Works
+      that You distribute, all copyright, patent, trademark, and
+      attribution notices from the Source form of the Work,
+      excluding those notices that do not pertain to any part of
+      the Derivative Works; and
+
+  (d) If the Work includes a "NOTICE" text file as part of its
+      distribution, then any Derivative Works that You distribute must
+      include a readable copy of the attribution notices contained
+      within such NOTICE file, excluding those notices that do not
+      pertain to any part of the Derivative Works, in at least one
+      of the following places: within a NOTICE text file distributed
+      as part of the Derivative Works; within the Source form or
+      documentation, if provided along with the Derivative Works; or,
+      within a display generated by the Derivative Works, if and
+      wherever such third-party notices normally appear. The contents
+      of the NOTICE file are for informational purposes only and
+      do not modify the License. You may add Your own attribution
+      notices within Derivative Works that You distribute, alongside
+      or as an addendum to the NOTICE text from the Work, provided
+      that such additional attribution notices cannot be construed
+      as modifying the License.
+
+  You may add Your own copyright statement to Your modifications and
+  may provide additional or different license terms and conditions
+  for use, reproduction, or distribution of Your modifications, or
+  for any such Derivative Works as a whole, provided Your use,
+  reproduction, and distribution of the Work otherwise complies with
+  the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+  any Contribution intentionally submitted for inclusion in the Work
+  by You to the Licensor shall be under the terms and conditions of
+  this License, without any additional terms or conditions.
+  Notwithstanding the above, nothing herein shall supersede or modify
+  the terms of any separate license agreement you may have executed
+  with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+  names, trademarks, service marks, or product names of the Licensor,
+  except as required for reasonable and customary use in describing the
+  origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+  agreed to in writing, Licensor provides the Work (and each
+  Contributor provides its Contributions) on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+  implied, including, without limitation, any warranties or conditions
+  of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+  PARTICULAR PURPOSE. You are solely responsible for determining the
+  appropriateness of using or redistributing the Work and assume any
+  risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+  whether in tort (including negligence), contract, or otherwise,
+  unless required by applicable law (such as deliberate and grossly
+  negligent acts) or agreed to in writing, shall any Contributor be
+  liable to You for damages, including any direct, indirect, special,
+  incidental, or consequential damages of any character arising as a
+  result of this License or out of the use or inability to use the
+  Work (including but not limited to damages for loss of goodwill,
+  work stoppage, computer failure or malfunction, or any and all
+  other commercial damages or losses), even if such Contributor
+  has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+  the Work or Derivative Works thereof, You may choose to offer,
+  and charge a fee for, acceptance of support, warranty, indemnity,
+  or other liability obligations and/or rights consistent with this
+  License. However, in accepting such obligations, You may act only
+  on Your own behalf and on Your sole responsibility, not on behalf
+  of any other Contributor, and only if You agree to indemnify,
+  defend, and hold each Contributor harmless for any liability
+  incurred by, or claims asserted against, such Contributor by reason
+  of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+  To apply the Apache License to your work, attach the following
+  boilerplate notice, with the fields enclosed by brackets "[]"
+  replaced with your own identifying information. (Don't include
+  the brackets!)  The text should be enclosed in the appropriate
+  comment syntax for the file format. We also recommend that a
+  file or class name and description of purpose be included on the
+  same "printed page" as the copyright notice for easier
+  identification within third-party archives.
+
+Copyright <YEAR> <COPYRIGHT HOLDER>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+--------------- APPENDIX 2: BSD-2-Clause License (Template) -----------
+
+Copyright <YEAR> <COPYRIGHT HOLDER>
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+--------------- APPENDIX 3: MIT License (Template) -----------
+
+Copyright <YEAR> <COPYRIGHT HOLDER>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -6,7 +6,18 @@ Command-line interface for Conjur.
 
 A complete reference guide is available at [conjur.org](https://www.conjur.org).
 
-## Quick start
+## Table of Contents
+- [Getting Started](#getting-started)
+    - [Quick Start](#quick-start)
+    - [Using This Project With Conjur OSS](#Using-conjur-cli-with-Conjur-OSS)
+- [Using Docker](#using-docker)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Getting Started 
+
+### Quick start
 
 ```sh-session
 $ gem install conjur-cli
@@ -15,7 +26,19 @@ $ conjur -v
 conjur version 6.0.0
 ```
 
+### Using conjur-cli with Conjur OSS 
+
+Are you using this project with [Conjur OSS](https://github.com/cyberark/conjur)? Then we 
+**strongly** recommend choosing the version of this project to use from the latest [Conjur OSS 
+suite release](https://docs.conjur.org/Latest/en/Content/Overview/Conjur-OSS-Suite-Overview.html). 
+Conjur maintainers perform additional testing on the suite release versions to ensure 
+compatibility. When possible, upgrade your Conjur version to match the 
+[latest suite release](https://docs.conjur.org/Latest/en/Content/ReleaseNotes/ConjurOSS-suite-RN.htm); 
+when using integrations, choose the latest suite release that matches your Conjur version. For any 
+questions, please contact us on [Discourse](https://discuss.cyberarkcommons.org/c/conjur/5).
+
 ## Using Docker
+
 [![Docker Build Status](https://img.shields.io/docker/build/conjurinc/cli5.svg)](https://hub.docker.com/r/conjurinc/cli5/)
 This software is included in the standalone cyberark/conjur-cli:5 Docker image. Docker containers are designed to be ephemeral, which means they don't store state after the container exits.
 
@@ -59,66 +82,287 @@ drwxr-xr-x  2 you  staff    68 Mar 29 14:16 .cache
 ```
 *Security notice:* the file `.netrc`, created or updated by `conjur authn login`, contains a user identity credential that can be used to access the Conjur API. You should remove it after use or otherwise secure it like you would another netrc file.
 
-## Development
+## Usage
 
-Create a sandbox environment in Docker using the `./dev` folder:
+```
+NAME
+    conjur - Command-line toolkit for managing roles, resources and privileges
 
-```sh-session
-$ cd dev
-dev $ ./start.sh
+SYNOPSIS
+    conjur [global options] command [command options] [arguments...]
+
+GLOBAL OPTIONS
+    --help    - Show this message
+    --version - Display the program version
 ```
 
-This will drop you into a bash shell in a container called `cli`. The sandbox also includes a Postgres container and Conjur server container. The environment is already setup to connect the CLI to the server:
+### Commands
+
+| Command                            | Description                                       |
+| ---------------------------------- | ------------------------------------------------- |
+| [authn](#conjur-authn)             | - Login and logout                                |
+| [check](#conjur-check)             | - Check for a privilege on a resource             |
+| [env](#conjur-env)                 | - Use values of Conjur variables in local context |
+| [host](#conjur-host)               | - Manage hosts                                    |
+| [hostfactory](#conjur-hostfactory) | - Manage host factories                           |
+| [init](#conjur-init)               | - Initialize the Conjur configuration             |
+| [ldap-sync](#conjur-ldap-sync)     | - LDAP sync management commands                   |
+| [list](#conjur-list)               | - List objects                                    |
+| [plugin](#conjur-plugin)           | - Manage plugins                                  |
+| [policy](#conjur-policy)           | - Manage policies                                 |
+| [pubkeys](#conjur-pubkeys)         | - Public keys service operations                  |
+| [resource](#conjur-resource)       | - Manage resources                                |
+| [role](#conjur-role)               | - Manage roles                                    |
+| [show](#conjur-show)               | - Show an object                                  |
+| [user](#conjur-user)               | - Manage users                                    |
+| [variable](#conjur-variable)       | - Manage variables                                |
+
+#### `conjur authn`
 
-* **CONJUR_APPLIANCE_URL** `http://conjur`
-* **CONJUR_ACCOUNT** `cucumber`
+```
+NAME
+   authn       - Login and logout
+SYNOPSIS
+    conjur [global options] authn authenticate [-H|--header] [-f filename|--filename filename]
+    conjur [global options] authn login [-p password|--password password] [-u username|--username username] login-name
+    conjur [global options] authn logout
+    conjur [global options] authn whoami
+COMMANDS
+    authenticate - Obtains an authentication token using the current logged-in
+                   user
+    login        - Logs in and caches credentials to netrc.
+    logout       - Logs out
+    whoami       - Prints out the current logged in username
+```
 
-You can obtain the API key for the role `cucumber:user:admin` from the Docker logs of the Conjur container. Use it to login:
+#### `conjur check`
+
+```
+NAME
+   check       - Check for a user’s privilege on a resource
+SYNOPSIS
+   conjur check [object] [privilege] [user]
+PRIVILEGES
+   read, write, execute
+```
+
+#### `conjur env`
 
-```sh-session
-root@2b5f618dfdcb:/# conjur authn login admin
-Please enter admin's password (it will not be echoed):
-Logged in
 ```
+NAME
+    env         - Use values of Conjur variables in local context
+SYNOPSIS
+    conjur [global options] env check [--policy arg] [--yaml arg] [-c FILE]
+    conjur [global options] env help
+    conjur [global options] env run [--policy arg] [--yaml arg] [-c FILE] -- command [arg1, arg2 ...]
+    conjur [global options] env template [--policy arg] [--yaml arg] [-c FILE] template.erb
 
-At this point, you can use any CLI command you like.
+COMMANDS
+    check    - Check availability of Conjur variables
+    help     - Print description of environment configuration format
+    run      - Execute external command with environment variables populated
+               from Conjur
+    template - Render ERB template with variables obtained from Conjur
 
-### Running Cucumber
+root@e1bfc649b68d:/# conjur env help
 
-To install dev packages, run `bundle` from within the container:
+Environment configuration (either stored in file referred by -c option or provided inline with --yaml option) should be a YAML document describing one-level Hash.
+Keys of the hash are 'local names', used to refer to variable values in convenient manner.  (See help for env:run and env:template for more details about how they are interpreted).
 
-```sh-session
-root@2b5f618dfdcb:/# cd /usr/src/cli-ruby/
-root@2b5f618dfdcb:/usr/src/cli-ruby# bundle
+Values of the hash may take one of the following forms: a) string b) string preceeded with !var tag c) string preceeded with !tmp tag.
+
+a) Plain string is just associated with local name without any calls to Conjur.
+
+b) String preceeded by !var tag is interpreted as an ID of the Conjur variable, which value should be obtained and associated with appropriate local name.
+
+c) String preceeded by !tmp tag is interpreted as an ID of the Conjur variable, which value should be stored in temporary file, which location should in turn be associated with appropriate local name.
+
+Example of environment configuration: 
+
+{ local_variable_1: 'literal value', local_variable_2: !var id/of/Conjur/Variable , local_variable_3: !tmp id/of/another/Conjur/variable }
 ```
 
-Then you can run the cucumber tests:
+#### `conjur host`
 
-```sh-session
-root@2b5f618dfdcb:/usr/src/cli-ruby# cucumber
-...
 ```
+NAME
+    host - Manage hosts
 
-## Contributing
+SYNOPSIS
+    conjur [global options] host layers HOST
+    conjur [global options] host rotate_api_key [--host arg|-h arg]
+
+COMMANDS
+    layers         - List the layers to which the host belongs
+    rotate_api_key - Rotate a host's API key
+```
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+#### `conjur hostfactory`
 
-## License
+```
+NAME
+    hostfactory - Manage host factories
+
+SYNOPSIS
+    conjur [global options] hostfactory hosts
+    conjur [global options] hostfactory tokens
+
+COMMANDS
+    hosts  - Operations on hosts
+    tokens - Operations on tokens
+```
+
+#### `conjur init`
+
+```
+NAME
+   init – Initialize the Conjur configuration
+SYNOPSIS
+   conjur [global options] init [-u URL of Conjur service] [-a account name]
+```
+
+#### `conjur ldap-sync`
+
+```
+NAME
+    ldap-sync - LDAP sync management commands
+
+SYNOPSIS
+    conjur [global options] ldap-sync policy
+
+COMMANDS
+    policy - Manage the policy used to sync Conjur and the LDAP server
+```
+
+#### `conjur list`
+
+```
+Lists conjur objects
+```
+
+#### `conjur plugin`
+
+```
+NAME
+    plugin - Manage plugins
+
+SYNOPSIS
+    conjur [global options] plugin install [-v version|--version version] PLUGIN
+    conjur [global options] plugin list
+    conjur [global options] plugin show PLUGIN
+    conjur [global options] plugin uninstall PLUGIN
+
+COMMANDS
+    install   - Install a plugin
+    list      - List installed plugins
+    show      - Show a plugin's details
+    uninstall - Uninstall a plugin
+```
+
+#### `conjur policy`
+
+```
+NAME
+    policy - Manage policies
+
+SYNOPSIS
+    conjur [global options] policy load [--delete] [--replace] POLICY FILENAME
+
+COMMANDS
+    load - Load a policy
+--delete – deletes a policy
+--replace – replaces a policy
+```
+
+#### `conjur pubkeys`
+
+```
+NAME
+   pubkeys - Public keys service operations
+SYNOPSIS
+   conjur [global options] pubkeys [USER]
+```
+
+#### `conjur resource`
+
+```
+NAME
+    resource - Manage resources
+
+SYNOPSIS
+    conjur [global options] resource exists RESOURCE
+    conjur [global options] resource permitted_roles RESOURCE PRIVILEGE
+
+COMMANDS
+    exists          - Determines whether a resource exists
+    permitted_roles - List roles with a specified privilege on the resource
+```
+
+#### `conjur role`
 
-Copyright 2016-2017 CyberArk
+```
+NAME
+    role - Manage roles
+
+SYNOPSIS
+    conjur [global options] role exists [--json] ROLE
+    conjur [global options] role members [-V|--verbose] ROLE
+    conjur [global options] role memberships [-s|--system] ROLE
+
+COMMANDS
+    exists      - Determines whether a role exists
+    members     - Lists all direct members of the role. The membership list is
+                  not recursively expanded.
+    memberships - Lists role memberships. The role membership list is
+                  recursively expanded.
+```
+
+#### `conjur show`
+
+```
+NAME
+   show        - Show an object
+SYNOPSIS
+   conjur show [object]
+```
+
+#### `conjur user`
+
+```
+NAME
+    user - Manage users
+
+SYNOPSIS
+    conjur [global options] user rotate_api_key [--user arg|-u arg]
+    conjur [global options] user update_password [-p arg|--password arg]
+
+COMMANDS
+    rotate_api_key  - Rotate a user's API key
+    update_password - Update the password of the logged-in user
+```
+
+#### `conjur variable`
+
+```
+NAME
+    variable - Manage variables
+
+SYNOPSIS
+    conjur [global options] variable value [-v arg|--version arg] VARIABLE
+    conjur [global options] variable values
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this software except in compliance with the License.
-You may obtain a copy of the License at
+COMMANDS
+    value  - Get a value
+    values - Access variable values
+```
 
-    http://www.apache.org/licenses/LICENSE-2.0
+## Contributing
+
+We welcome contributions of all kinds to this repository. For instructions on how to get started and descriptions of our development workflows, please see our [contributing
+guide][contrib].
+
+[contrib]: https://github.com/cyberark/conjur/blob/master/CONTRIBUTING.md
+
+## License
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+This repository is licensed under Apache License 2.0 - see [`LICENSE`](LICENSE) for more details.