Skip to content

Commit

Permalink
renaming workspace to auth
Browse files Browse the repository at this point in the history
  • Loading branch information
rusq committed Jan 1, 2024
1 parent 5a643fc commit 56652ee
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,22 @@ var flagmask = cfg.OmitAll
var CmdWorkspace = &base.Command{
Run: nil,
Wizard: nil,
UsageLine: "slackdump workspace",
Short: "authenticate or choose workspace to run on",
UsageLine: "slackdump auth",
Short: "authenticate or choose already authenticated workspace to run on",
Long: `
# Workspace Command
# Auth Command
Slackdump supports working with multiple Slack Workspaces without the need
to authenticate again (unless login credentials are expired or became invalid
due to some other reason).
**Workspace** command allows to authenticate in a **new** Slack Workspace,
**Auth** command allows to authenticate in a **new** Slack Workspace,
**list** already authenticated workspaces, **select** a workspace that you have
previously logged in to, or **del**ete an existing workspace.
To learn more about different login options, run:
slackdump help login
slackdump help auth
Workspaces are stored on this device in the Cache directory, which is
automatically detected to be:
Expand Down
File renamed without changes.
17 changes: 9 additions & 8 deletions slackdump.1
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ help, or exit.
.Sh COMMANDS
The following commands are supported (listed in alphabetical order):
.Bl -tag -width workspace
.It Cm auth
Manage stored credentials for authenticated workspaces, or authenticates in a
new workspace.
.It Cm config Ar subcommand
Allows to perform different operations on the API limits configuration
files.
Expand All @@ -72,10 +75,10 @@ Display help. To get the subcommand help, use the combination of
For example, to get help on the
.Ar new
subcommand of the
.Cm workspace
.Cm auth
command, run the following:
.Bd -literal -offset indent
.Nm Cm workspace Cm help Ar new
.Nm Cm auth Cm help Ar new
.Ed
.It Cm list
List channels or users in the desired format
Expand All @@ -84,8 +87,6 @@ List channels or users in the desired format
Export workspace in the internal Chunk format.
.It Cm version
Display version information.
.It Cm workspace
Manage Slack workspaces authentication.
.El
.\"
.Sh FLAGS
Expand Down Expand Up @@ -164,7 +165,7 @@ Enables verbose output, prints a lot of debugging information.
.It Fl workspace Ar name
Allows to override the currently selected workspace for the session.
See also the
.Cm workspace Ar select
.Cm auth Ar select
command.
.El
.\"
Expand All @@ -174,7 +175,7 @@ The quickest way to get started is to run the following command:
.Bl -enum -compact
.It
Authenticate in a new workspace using the
.Cm workspace
.Cm auth
.Ar new
command;
.It
Expand Down Expand Up @@ -279,7 +280,7 @@ for more details.
.It Ev SLACK_WORKSPACE
Allows to specify Slack workspace name (overrides currently selected
workspace). See
.Ar workspace
.Ar auth
command for more details.
.It Ev TRACE_FILE
Contains path to a file where trace output will be written.
Expand Down Expand Up @@ -308,7 +309,7 @@ Authenticate in a new workspace
.Lk https://myworkspace.slack.com
:
.Bd -literal -offset indent
.Nm Cm workspace Cm new Ar myworkspace
.Nm Cm auth Cm new Ar myworkspace
.Ed
.Pp
Run full workspace export:
Expand Down

0 comments on commit 56652ee

Please sign in to comment.