Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove legacy name for cli tool #194

Merged
merged 3 commits into from
Jul 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/howto/templated_secrets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ to leave the rest of the value as-is, and not run Jinja2 on it:
.. code:: yaml

- name: Add templated secrets
command: vault set {{ item.path }} '{{ item.key }}={{ item.template }}'
command: vault-cli set {{ item.path }} '{{ item.key }}={{ item.template }}'
loop:
- path: path/one
key: mykey
Expand Down
6 changes: 6 additions & 0 deletions docs/howto/upgrade.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
Upgrade ``vault-cli`` from previous version
===========================================

From 1.x to 2.x
~~~~~~~~~~~~~~~

Switch command name from ``vault`` to ``vault-cli`` if you're using it.

From 0.x to 1.x
~~~~~~~~~~~~~~~

Expand All @@ -26,6 +31,7 @@ variables names.
but ``vault`` is kept for backwards compatibility. Because ``vault-cli 0.x`` was
only compatible with the name ``vault``, the examples below are written with
``vault``
After 2.0, command ``vault`` has disappeared.

The following list shows how to update your commands:

Expand Down
10 changes: 5 additions & 5 deletions docs/howto/write.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Secrets in the vault are either written manually or generated by secret engines

.. code:: console

$ vault set a b=c
$ vault-cli set a b=c
Done
$ vault get a
$ vault-cli get a
---
b: c

Expand All @@ -31,9 +31,9 @@ to redefine a secret object from scratch, use ``--clear``:

.. code:: console

$ vault set a f=g
$ vault-cli set a f=g
Done
$ vault get a
$ vault-cli get a
---
f: g

Expand Down Expand Up @@ -64,7 +64,7 @@ the output of a program into the vault:
Done

$ # Or:
$ pwgen 64 1 | vault set myapp secret_key=-
$ pwgen 64 1 | vault-cli set myapp secret_key=-
Done

You can also load a several key/values in YAML (or JSON) format from a
Expand Down
1 change: 0 additions & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ install_requires =
[options.entry_points]
console_scripts =
vault-cli = vault_cli.cli:main
vault = vault_cli.cli:main

[options.extras_require]

Expand Down