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

Adding documentation for the logout command #691

Merged
merged 3 commits into from Dec 30, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/using-concourse/fly-cli.any
Expand Up @@ -78,6 +78,28 @@ flag. Once you've learned what the commands do, you may want to consult
\code{example} Concourse instance.
}

\section{\code{logout}\aux{: Remove authentication and delete Concourse targets}}{fly-logout}{
There are cases when you would like to remove all evidence of a particular
target. This is achieved by the \code{logout} command. There are two variants
of this command, one to get rid of a specific target, and another to remove
all targets from the \code{~/.flyrc} file.

To remove a specific target run:

This comment was marked as spam.

This comment was marked as spam.


\codeblock{bash}{
$ fly -t example logout
}

To remove all targets run:

This comment was marked as spam.

This comment was marked as spam.


\codeblock{bash}{
$ fly logout -a
}

Note: These two variations are mutually exclusive. If the target parameter
\code{-t} and all parameter \code{-a} are both specified, an error will occur.
}

\section{\code{targets}\aux{: List the current targets}}{fly-targets}{
To see what targets are currently known to \code{fly}, run:

Expand Down