Wish

https://pkg.go.dev/github.com/charmbracelet/wish
Admin
Wish is a Go library and SSH server with sensible defaults and middlewares designed to make building...
Tokens:8,492
Snippets:120
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Listen function

Source: https://pkg.go.dev/github.com/charmbracelet/wish/testsession

Starts a test server for SSH testing.

```go
func Listen(tb testing.TB, srv *ssh.Server) string
```

--------------------------------

### func Listen

Source: https://pkg.go.dev/github.com/charmbracelet/wish/testsession

Starts a test server and returns the address.

```APIDOC
## func Listen(tb testing.TB, srv *ssh.Server) string

### Description
Listen starts a test server.

### Parameters
- **tb** (testing.TB) - The testing interface.
- **srv** (*ssh.Server) - The SSH server instance.

### Returns
- **string** - The address of the started test server.
```

--------------------------------

### func New

Source: https://pkg.go.dev/github.com/charmbracelet/wish/testsession

Starts a local SSH server and returns a client session.

```APIDOC
## func New(tb testing.TB, srv *ssh.Server, cfg *gossh.ClientConfig) *gossh.Session

### Description
New starts a local SSH server with the given config and returns a client session. It automatically closes everything afterwards.

### Parameters
- **tb** (testing.TB) - The testing interface.
- **srv** (*ssh.Server) - The SSH server instance.
- **cfg** (*gossh.ClientConfig) - The SSH client configuration.

### Returns
- ***gossh.Session** - A client session instance.
```

--------------------------------

### New function

Source: https://pkg.go.dev/github.com/charmbracelet/wish/testsession

Starts a local SSH server and returns a client session, automatically handling cleanup.

```go
func New(tb testing.TB, srv *ssh.Server, cfg *gossh.ClientConfig) *gossh.Session
```

--------------------------------

### SystemD Management Commands

Source: https://pkg.go.dev/github.com/charmbracelet/wish

Commands to reload, start, and manage the systemd service for a Wish application.

```bash
# need to run this every time you change the unit file
sudo systemctl daemon-reload

# start/restart/stop/etc:
sudo systemctl start myapp
```

--------------------------------

### Configure Server Options

Source: https://pkg.go.dev/github.com/charmbracelet/wish

Various options for configuring server address, authentication, banners, and host keys.

```go
func WithAddress(addr string) ssh.Option
```

```go
func WithAuthorizedKeys(path string) ssh.Option
```

```go
func WithBanner(banner string) ssh.Option
```

```go
func WithBannerHandler(h ssh.BannerHandler) ssh.Option
```

```go
func WithHostKeyPEM(pem []byte) ssh.Option
```

--------------------------------

### NewServer

Source: https://pkg.go.dev/github.com/charmbracelet/wish

Creates a new SSH server instance with the provided options.

```APIDOC
## func NewServer(ops ...ssh.Option) (*ssh.Server, error)

### Description
NewServer returns a default SSH server with the provided Middleware. A new SSH key pair of type ed25519 will be created if one does not exist. By default this server will accept all incoming connections, password and public key.
```

--------------------------------

### Initialize SSH Server

Source: https://pkg.go.dev/github.com/charmbracelet/wish

Creates a new SSH server instance with optional configurations. By default, it generates an ed25519 key pair if missing and accepts all connections.

```go
func NewServer(ops ...ssh.Option) (*ssh.Server, error)
```

--------------------------------

### NewFileSystemHandler Function

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Returns a handler based on the specified directory.

```go
func NewFileSystemHandler(root string) Handler
```

--------------------------------

### GetInfo Function

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Returns information about the given command.

```go
func GetInfo(cmd []string) Info
```

--------------------------------

### Create New RateLimiter

Source: https://pkg.go.dev/github.com/charmbracelet/wish/ratelimiter

Initializes a new RateLimiter with specified rate, burst capacity, and cache size.

```go
func NewRateLimiter(r rate.Limit, burst int, maxEntries int) RateLimiter
```

--------------------------------

### MakeOptions Function

Source: https://pkg.go.dev/github.com/charmbracelet/wish/bubbletea

Returns tea.ProgramOption values for input and output, accounting for PTY allocation.

```go
func MakeOptions(sess ssh.Session) []tea.ProgramOption
```

--------------------------------

### DirEntry Methods

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Methods for appending entries to a directory and writing directory contents.

```go
func (e *DirEntry) Append(entry Entry)
```

```go
func (e *DirEntry) Write(w io.Writer) error
```

--------------------------------

### Basic Connection Logging Middleware

Source: https://pkg.go.dev/github.com/charmbracelet/wish/logging

Provides basic connection logging using the default standard logger.

```go
func Middleware() wish.Middleware
```

--------------------------------

### MakeRenderer Function

Source: https://pkg.go.dev/github.com/charmbracelet/wish/bubbletea

Returns a lipgloss renderer configured for the current SSH session.

```go
func MakeRenderer(sess ssh.Session) *lipgloss.Renderer
```

--------------------------------

### Server Configuration Options

Source: https://pkg.go.dev/github.com/charmbracelet/wish

Options for configuring the SSH server behavior.

```APIDOC
## Server Configuration Options

### Description
Functions that return `ssh.Option` to configure various aspects of the SSH server.

### Options
- `WithAddress(addr string)`: Sets the address to listen on.
- `WithAuthorizedKeys(path string)`: Allows the use of an SSH authorized_keys file.
- `WithBanner(banner string)`: Sets the server banner.
- `WithBannerHandler(h ssh.BannerHandler)`: Sets the server banner handler.
- `WithHostKeyPEM(pem []byte)`: Sets the host key from a PEM block.
```

--------------------------------

### EnsureRepo function

Source: https://pkg.go.dev/github.com/charmbracelet/wish/git

Ensures a directory exists and is initialized as a bare Git repository.

```go
func EnsureRepo(dir, repo string) error
```

--------------------------------

### Configuration Options

Source: https://pkg.go.dev/github.com/charmbracelet/wish

Functions that return ssh.Option to configure an SSH server instance.

```APIDOC
## func WithHostKeyPath(path string) ssh.Option

Sets the path to the private key for the SSH server.

## func WithIdleTimeout(d time.Duration) ssh.Option

Sets the connection's idle timeout.

## func WithKeyboardInteractiveAuth(h ssh.KeyboardInteractiveHandler) ssh.Option

Sets the keyboard interactive authentication handler.

## func WithMaxTimeout(d time.Duration) ssh.Option

Sets the connection's absolute timeout.

## func WithMiddleware(mw ...Middleware) ssh.Option

Composes the provided Middleware and returns an ssh.Option.

## func WithPasswordAuth(p ssh.PasswordHandler) ssh.Option

Sets the password authentication handler.

## func WithPublicKeyAuth(h ssh.PublicKeyHandler) ssh.Option

Sets the public key authentication handler.

## func WithSubsystem(key string, h ssh.SubsystemHandler) ssh.Option

Sets the subsystem handler for a given protocol.

## func WithTrustedUserCAKeys(path string) ssh.Option

Authorizes certificates signed with the given Certificate Authority public key.

## func WithVersion(version string) ssh.Option

Sets the server version string.
```

--------------------------------

### Structured Connection Logging Middleware

Source: https://pkg.go.dev/github.com/charmbracelet/wish/logging

Provides connection logging in a structured format using default settings.

```go
func StructuredMiddleware() wish.Middleware
```

--------------------------------

### SystemD Unit File for Wish App

Source: https://pkg.go.dev/github.com/charmbracelet/wish

A sample systemd service configuration for running a Wish application as a background service.

```ini
[Unit]
Description=My App
After=network.target

[Service]
Type=simple
User=myapp
Group=myapp
WorkingDirectory=/home/myapp/
ExecStart=/usr/bin/myapp
Restart=on-failure

[Install]
WantedBy=multi-user.target
```

--------------------------------

### func MakeOptions

Source: https://pkg.go.dev/github.com/charmbracelet/wish/bubbletea

Returns tea.WithInput and tea.WithOutput program options, accounting for emulated or allocated PTYs.

```APIDOC
## func MakeOptions(sess ssh.Session) []tea.ProgramOption

### Description
MakeOptions returns the tea.WithInput and tea.WithOutput program options taking into account possible Emulated or Allocated PTYs.

### Parameters
- **sess** (ssh.Session) - Required - The SSH session to derive options from.
```

--------------------------------

### Configure SSH Server Options

Source: https://pkg.go.dev/github.com/charmbracelet/wish

Functions to configure various aspects of an SSH server, such as authentication, timeouts, and middleware.

```go
func WithHostKeyPath(path string) ssh.Option
```

```go
func WithIdleTimeout(d time.Duration) ssh.Option
```

```go
func WithKeyboardInteractiveAuth(h ssh.KeyboardInteractiveHandler) ssh.Option
```

```go
func WithMaxTimeout(d time.Duration) ssh.Option
```

```go
func WithMiddleware(mw ...Middleware) ssh.Option
```

```go
func WithPasswordAuth(p ssh.PasswordHandler) ssh.Option
```

```go
func WithPublicKeyAuth(h ssh.PublicKeyHandler) ssh.Option
```

```go
func WithSubsystem(key string, h ssh.SubsystemHandler) ssh.Option
```

```go
func WithTrustedUserCAKeys(path string) ssh.Option
```

```go
func WithVersion(version string) ssh.Option
```

--------------------------------

### func Middleware

Source: https://pkg.go.dev/github.com/charmbracelet/wish/bubbletea

Hooks the input and output of an SSH session into a tea.Program and handles window resize events.

```APIDOC
## func Middleware(handler Handler) wish.Middleware

### Description
Middleware takes a Handler and hooks the input and output for the ssh.Session into the tea.Program. It also captures window resize events and sends them to the tea.Program as tea.WindowSizeMsgs.

### Parameters
- **handler** (Handler) - Required - The handler function to execute for the session.
```

--------------------------------

### Middleware Function

Source: https://pkg.go.dev/github.com/charmbracelet/wish/bubbletea

Hooks SSH session input/output into a tea.Program and handles window resize events.

```go
func Middleware(handler Handler) wish.Middleware
```

--------------------------------

### Configure SSH Host for Local Development

Source: https://pkg.go.dev/github.com/charmbracelet/wish

Add this to your ~/.ssh/config to prevent localhost known_hosts conflicts when testing Wish applications.

```text
Host localhost
    UserKnownHostsFile /dev/null
```

--------------------------------

### Hooks interface

Source: https://pkg.go.dev/github.com/charmbracelet/wish/git

Interface for implementing custom authorization and post-push/fetch notifications.

```go
type Hooks interface {
	AuthRepo(string, ssh.PublicKey) AccessLevel
	Push(string, ssh.PublicKey)
	Fetch(string, ssh.PublicKey)
}
```

--------------------------------

### NewFileSystemHandler

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Creates a handler that supports both copying files from and to the client based on a local directory.

```APIDOC
## func NewFileSystemHandler(root string) Handler

### Description
Returns a Handler implementation that manages SCP operations (both directions) for the specified root directory.

### Parameters
- **root** (string) - Required - The root directory path for the file system handler.
```

--------------------------------

### NewClientSession function

Source: https://pkg.go.dev/github.com/charmbracelet/wish/testsession

Creates a new client session connected to the specified address.

```go
func NewClientSession(tb testing.TB, addr string, config *gossh.ClientConfig) (*gossh.Session, error)
```

--------------------------------

### MiddlewareWithFormat function

Source: https://pkg.go.dev/github.com/charmbracelet/wish/elapsed

Returns a middleware that logs the session's elapsed time using a custom format string. Must be placed as the last middleware in the chain for accuracy.

```go
func MiddlewareWithFormat(format string) wish.Middleware
```

--------------------------------

### Structured Logger Middleware with Configuration

Source: https://pkg.go.dev/github.com/charmbracelet/wish/logging

Provides structured connection logging with a specific logger and log level.

```go
func StructuredMiddlewareWithLogger(logger *log.Logger, level log.Level) wish.Middleware
```

--------------------------------

### MiddlewareWithProgramHandler Function

Source: https://pkg.go.dev/github.com/charmbracelet/wish/bubbletea

Allows custom ProgramHandler access to the underlying tea.Program with a specified color profile.

```go
func MiddlewareWithProgramHandler(handler ProgramHandler, profile termenv.Profile) wish.Middleware
```

--------------------------------

### MiddlewareWithColorProfile Function

Source: https://pkg.go.dev/github.com/charmbracelet/wish/bubbletea

Configures middleware with a specific minimum color profile for the application.

```go
func MiddlewareWithColorProfile(handler Handler, profile termenv.Profile) wish.Middleware
```

--------------------------------

### FileEntry Write Method

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Writes a file to the provided writer.

```go
func (e *FileEntry) Write(w io.Writer) error
```

--------------------------------

### NewFileEntry Function

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Creates a new file entry for a given path, optionally providing a closing function.

```go
NewFileEntry(ssh.Session, string) (*FileEntry, func() error, error)
```

--------------------------------

### Custom Logger Middleware

Source: https://pkg.go.dev/github.com/charmbracelet/wish/logging

Provides basic connection logging using a custom logger implementation.

```go
func MiddlewareWithLogger(logger Logger) wish.Middleware
```

--------------------------------

### Middleware function

Source: https://pkg.go.dev/github.com/charmbracelet/wish/recover

Recovers from panics and logs to stderr.

```go
func Middleware(mw ...wish.Middleware) wish.Middleware
```

--------------------------------

### func Middleware

Source: https://pkg.go.dev/github.com/charmbracelet/wish/logging

Provides basic connection logging using the standard logger. Logs connection details on connect and duration on disconnect.

```APIDOC
## func Middleware()

### Description
Provides basic connection logging. Connects are logged with the remote address, invoked command, TERM setting, window dimensions, client version, and if the auth was public key based. Disconnect will log the remote address and connection duration.

### Signature
`func Middleware() wish.Middleware`
```

--------------------------------

### AccessLevel type and constants

Source: https://pkg.go.dev/github.com/charmbracelet/wish/git

Defines the levels of access allowed for a repository.

```go
type AccessLevel int
```

```go
const (
	// NoAccess does not allow access to the repo.
	NoAccess AccessLevel = iota

	// ReadOnlyAccess allows read-only access to the repo.
	ReadOnlyAccess

	// ReadWriteAccess allows read and write access to the repo.
	ReadWriteAccess

	// AdminAccess allows read, write, and admin access to the repo.
	AdminAccess
)
```

--------------------------------

### Command Execution Types and Functions

Source: https://pkg.go.dev/github.com/charmbracelet/wish

Types and functions for wrapping and executing commands within an SSH session.

```go
type Cmd struct {
	// contains filtered or unexported fields
}
```

```go
func Command(s ssh.Session, name string, args ...string) *Cmd
```

```go
func CommandContext(ctx context.Context, s ssh.Session, name string, args ...string) *Cmd
```

```go
func (c *Cmd) Environ() []string
```

```go
func (c *Cmd) Run() error
```

```go
func (c *Cmd) SetDir(dir string)
```

```go
func (c *Cmd) SetEnv(env []string)
```

```go
func (*Cmd) SetStderr(io.Writer)
```

```go
func (*Cmd) SetStdin(io.Reader)
```

```go
func (*Cmd) SetStdout(io.Writer)
```

--------------------------------

### Handler Interface

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Interface for handling both SCP directions.

```go
type Handler interface {
	CopyFromClientHandler
	CopyToClientHandler
}
```

--------------------------------

### Write String to Session

Source: https://pkg.go.dev/github.com/charmbracelet/wish

Writes a string to the session's standard output.

```go
func WriteString(s ssh.Session, v string) (int, error)
```

--------------------------------

### MiddlewareWithLogger function

Source: https://pkg.go.dev/github.com/charmbracelet/wish/recover

Recovers from panics and logs to the provided logger.

```go
func MiddlewareWithLogger(logger Logger, mw ...wish.Middleware) wish.Middleware
```

--------------------------------

### DirEntry Structure

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Represents a directory entry with children, name, path, mode, and timestamps.

```go
type DirEntry struct {
	Children []Entry
	Name     string
	Filepath string
	Mode     fs.FileMode
	Atime    int64
	Mtime    int64
}
```

--------------------------------

### Middleware function

Source: https://pkg.go.dev/github.com/charmbracelet/wish/git

Adds Git server functionality to an SSH server using the provided repository directory and authorization hooks.

```go
func Middleware(repoDir string, gh Hooks) wish.Middleware
```

--------------------------------

### func MiddlewareWithColorProfile

Source: https://pkg.go.dev/github.com/charmbracelet/wish/bubbletea

Allows specifying the minimum color profile required for the program.

```APIDOC
## func MiddlewareWithColorProfile(handler Handler, profile termenv.Profile) wish.Middleware

### Description
MiddlewareWithColorProfile allows you to specify the minimum number of colors this program needs to work properly. If the client's color profile has less colors than p, p will be forced.

### Parameters
- **handler** (Handler) - Required - The handler function to execute.
- **profile** (termenv.Profile) - Required - The minimum color profile to enforce.
```

--------------------------------

### CopyToClientHandler Interface

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Handles file transfers from the server to the client, including globbing and directory walking.

```go
type CopyToClientHandler interface {
	// Glob should be implemented if you want to provide server-side globbing
	// support.
	//
	// A minimal implementation to disable it is to return `[]string{s}, nil`.
	//
	// Note: if your other functions expect a relative path, make sure that
	// your Glob implementation returns relative paths as well.
	Glob(ssh.Session, string) ([]string, error)

	// WalkDir must be implemented if you want to allow recursive copies.
	WalkDir(ssh.Session, string, fs.WalkDirFunc) error

	// NewDirEntry should provide a *DirEntry for the given path.
	NewDirEntry(ssh.Session, string) (*DirEntry, error)
```

--------------------------------

### CopyFromClientHandler Interface

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Handles file transfers initiated from the client to the server.

```go
type CopyFromClientHandler interface {
	// Mkdir should created the given dir.
	// Note that this usually shouldn't use os.MkdirAll and the like.
	Mkdir(ssh.Session, *DirEntry) error

	// Write should write the given file.
	Write(ssh.Session, *FileEntry) (int64, error)
}
```

--------------------------------

### Info Structure

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Provides information about the current SCP operation.

```go
type Info struct {
	// Ok is true if the current session is a SCP.
	Ok bool

	// Recursive is true if its a recursive SCP.
	Recursive bool

	// Path is the server path of the scp operation.
	Path string

	// Op is the SCP operation kind.
	Op Op
}
```

--------------------------------

### FileEntry Structure

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Represents a file entry that reads from a reader.

```go
type FileEntry struct {
	Name     string
	Filepath string
	Mode     fs.FileMode
	Size     int64
	Reader   io.Reader
	Atime    int64
	Mtime    int64
}
```

--------------------------------

### func StructuredMiddleware

Source: https://pkg.go.dev/github.com/charmbracelet/wish/logging

Provides basic connection logging in a structured format using the default logger.

```APIDOC
## func StructuredMiddleware()

### Description
Provides basic connection logging in a structured form. Connects are logged with the remote address, invoked command, TERM setting, window dimensions, client version, and if the auth was public key based. Disconnect will log the remote address and connection duration.

### Signature
`func StructuredMiddleware() wish.Middleware`
```

--------------------------------

### func Middleware

Source: https://pkg.go.dev/github.com/charmbracelet/wish/git

Creates a wish middleware that adds Git server functionality to an SSH server.

```APIDOC
## func Middleware(repoDir string, gh Hooks) wish.Middleware

### Description
Adds Git server functionality to an SSH server. Repositories are stored in the specified directory, and the provided Hooks implementation is used for per-repository access control and post-operation notifications.

### Parameters
- **repoDir** (string) - Required - The directory where repositories are stored.
- **gh** (Hooks) - Required - The implementation of authorization and notification hooks.
```

--------------------------------

### Middleware Function Signature

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Creates a wish middleware using the provided CopyToClientHandler and CopyFromClientHandler.

```go
func Middleware(rh CopyToClientHandler, wh CopyFromClientHandler) wish.Middleware
```

--------------------------------

### Handler Type

Source: https://pkg.go.dev/github.com/charmbracelet/wish/bubbletea

Defines the function signature for implementing Bubble Tea apps within SSH middleware.

```go
type Handler func(sess ssh.Session) (tea.Model, []tea.ProgramOption)
```

--------------------------------

### Print to Session STDOUT

Source: https://pkg.go.dev/github.com/charmbracelet/wish

Functions for writing formatted or unformatted output to the SSH session's standard output.

```go
func Print(s ssh.Session, v ...interface{})
```

```go
func Printf(s ssh.Session, f string, v ...interface{})
```

```go
func Println(s ssh.Session, v ...interface{})
```

--------------------------------

### Command Execution

Source: https://pkg.go.dev/github.com/charmbracelet/wish

Utilities for running commands within an SSH session.

```APIDOC
## func Command(s ssh.Session, name string, args ...string) *Cmd

Creates a command that sets stdin, stdout, and stderr to the current session's PTY, or the session itself if no PTY exists.

## func CommandContext(ctx context.Context, s ssh.Session, name string, args ...string) *Cmd

Similar to Command but allows providing a context for the execution.

## func (*Cmd) Run() error

Runs the program and waits for it to finish.
```

--------------------------------

### Create System User for Wish App

Source: https://pkg.go.dev/github.com/charmbracelet/wish

Command to create a dedicated system user for running a Wish application securely.

```bash
useradd --system --user-group --create-home myapp
```

--------------------------------

### func MiddlewareWithLogger

Source: https://pkg.go.dev/github.com/charmbracelet/wish/logging

Provides basic connection logging using a custom logger implementation.

```APIDOC
## func MiddlewareWithLogger(logger Logger)

### Description
Provides basic connection logging using a provided logger. Connects are logged with the remote address, invoked command, TERM setting, window dimensions, client version, and if the auth was public key based. Disconnect will log the remote address and connection duration.

### Signature
`func MiddlewareWithLogger(logger Logger) wish.Middleware`
```

--------------------------------

### func StructuredMiddlewareWithLogger

Source: https://pkg.go.dev/github.com/charmbracelet/wish/logging

Provides basic connection logging in a structured format with a custom logger and log level.

```APIDOC
## func StructuredMiddlewareWithLogger(logger *log.Logger, level log.Level)

### Description
Provides basic connection logging in a structured form using a specific logger and log level. Connects are logged with the remote address, invoked command, TERM setting, window dimensions, client version, and if the auth was public key based. Disconnect will log the remote address and connection duration.

### Signature
`func StructuredMiddlewareWithLogger(logger *log.Logger, level log.Level) wish.Middleware`
```

--------------------------------

### RootEntry Structure and Methods

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Represents a root entry that can contain children.

```go
type RootEntry []Entry
```

```go
func (e *RootEntry) Append(entry Entry)
```

```go
func (e *RootEntry) Write(w io.Writer) error
```

--------------------------------

### GetInfo

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Parses an SCP command string to retrieve information about the operation.

```APIDOC
## func GetInfo(cmd []string) Info

### Description
Analyzes the provided command arguments to determine if an SCP operation is occurring, whether it is recursive, the target path, and the operation type.

### Parameters
- **cmd** ([]string) - Required - The command arguments to parse.

### Response
- **Info** (struct) - Contains Ok (bool), Recursive (bool), Path (string), and Op (Op).
```

--------------------------------

### Session Utilities

Source: https://pkg.go.dev/github.com/charmbracelet/wish

Functions for interacting with an active SSH session.

```APIDOC
## func WriteString(s ssh.Session, v string) (int, error)

Writes the given string to the session's STDOUT.
```

--------------------------------

### func EnsureRepo

Source: https://pkg.go.dev/github.com/charmbracelet/wish/git

Ensures that a directory exists and is initialized as a bare Git repository.

```APIDOC
## func EnsureRepo(dir, repo string) error

### Description
Ensures the specified repository exists within the given directory. If the path does not exist, it is created; if it is not a Git repository, it is initialized as a bare repository.

### Parameters
- **dir** (string) - Required - The base directory where the repository is located.
- **repo** (string) - Required - The name of the repository.

### Returns
- **error** - Returns an error if the operation fails.
```

--------------------------------

### Fatal function

Source: https://pkg.go.dev/github.com/charmbracelet/wish/git

Prints a message to the SSH session's STDOUT formatted as a Git response and exits with status 1.

```go
func Fatal(s ssh.Session, v ...interface{})
```

--------------------------------

### func MiddlewareWithProgramHandler

Source: https://pkg.go.dev/github.com/charmbracelet/wish/bubbletea

Allows specifying a custom ProgramHandler and minimum color profile for advanced middleware creation.

```APIDOC
## func MiddlewareWithProgramHandler(handler ProgramHandler, profile termenv.Profile) wish.Middleware

### Description
MiddlewareWithProgramHandler allows you to specify the ProgramHandler to be able to access the underlying tea.Program, and the minimum supported color profile. This is useful for creating custom middlewares that need access to tea.Program.

### Parameters
- **handler** (ProgramHandler) - Required - The program handler function.
- **profile** (termenv.Profile) - Required - The minimum color profile to enforce.
```

--------------------------------

### Middleware Definition

Source: https://pkg.go.dev/github.com/charmbracelet/wish

Defines the structure for middleware functions in the SSH server.

```go
type Middleware func(next ssh.Handler) ssh.Handler
```

--------------------------------

### Middleware Function Signature

Source: https://pkg.go.dev/github.com/charmbracelet/wish/ratelimiter

Provides the signature for the rate limiting middleware.

```go
func Middleware(limiter RateLimiter) wish.Middleware
```

--------------------------------

### Middleware function signature

Source: https://pkg.go.dev/github.com/charmbracelet/wish/accesscontrol

Defines the signature for the accesscontrol middleware, which accepts a variadic list of allowed command strings.

```go
func Middleware(cmds ...string) wish.Middleware
```

--------------------------------

### Entry Interface

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Defines the interface for objects that can write themselves in SCP format.

```go
type Entry interface {
	// Write the current entry in SCP format.
	Write(io.Writer) error
	// contains filtered or unexported methods
}
```

--------------------------------

### func NewClientSession

Source: https://pkg.go.dev/github.com/charmbracelet/wish/testsession

Creates a new client session to the specified address.

```APIDOC
## func NewClientSession(tb testing.TB, addr string, config *gossh.ClientConfig) (*gossh.Session, error)

### Description
NewClientSession creates a new client session to the given address.

### Parameters
- **tb** (testing.TB) - The testing interface.
- **addr** (string) - The address to connect to.
- **config** (*gossh.ClientConfig) - The SSH client configuration.

### Returns
- ***gossh.Session** - The created client session.
- **error** - An error if the session creation fails.
```

--------------------------------

### func Middleware

Source: https://pkg.go.dev/github.com/charmbracelet/wish/elapsed

Returns a middleware that logs the elapsed time of the session. Must be called as the last middleware in the chain.

```APIDOC
## func Middleware()

### Description
Returns a middleware that logs the elapsed time of the session. In order to provide an accurate elapsed time for the entire session, this must be called as the last middleware in the chain.

### Signature
`func Middleware() wish.Middleware`
```

--------------------------------

### func NewRateLimiter

Source: https://pkg.go.dev/github.com/charmbracelet/wish/ratelimiter

Creates a new RateLimiter instance that tracks connection rates per remote IP address.

```APIDOC
## func NewRateLimiter(r rate.Limit, burst int, maxEntries int) RateLimiter

### Description
Returns a new RateLimiter that allows events up to the specified rate, permits bursts of at most burst tokens, and maintains a cache of maxEntries limiters.

### Parameters
- **r** (rate.Limit) - The rate limit for connections.
- **burst** (int) - The maximum number of burst tokens allowed.
- **maxEntries** (int) - The maximum number of entries to keep in the internal LRU cache.

### Returns
- **RateLimiter** (interface) - An implementation of the RateLimiter interface.
```

--------------------------------

### func Fatal

Source: https://pkg.go.dev/github.com/charmbracelet/wish/git

Prints a message to the SSH session as a Git response and exits with status 1.

```APIDOC
## func Fatal(s ssh.Session, v ...interface{})

### Description
Prints the provided arguments to the SSH session's standard output formatted as a Git response and terminates the session with an exit code of 1.

### Parameters
- **s** (ssh.Session) - Required - The active SSH session.
- **v** (...interface{}) - Required - The values to print.
```

--------------------------------

### func Middleware

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Middleware provides a wish middleware using the given CopyToClientHandler and CopyFromClientHandler.

```APIDOC
## func Middleware

### Description
Middleware provides a wish middleware using the given CopyToClientHandler and CopyFromClientHandler.

### Signature
func Middleware(rh CopyToClientHandler, wh CopyFromClientHandler) wish.Middleware
```

--------------------------------

### func Middleware

Source: https://pkg.go.dev/github.com/charmbracelet/wish/comment

Middleware prints a comment at the end of the session.

```APIDOC
## func Middleware(comment string) wish.Middleware

### Description
Middleware prints a comment at the end of the session.

### Signature
`func Middleware(comment string) wish.Middleware`

### Parameters
- **comment** (string) - The text to be printed at the end of the session.

### Returns
- **wish.Middleware** - A middleware function compatible with the wish package.
```

--------------------------------

### func Middleware

Source: https://pkg.go.dev/github.com/charmbracelet/wish/accesscontrol

Middleware restricts command execution to a specified list of allowed commands. If a user attempts to execute a command not in the list, the connection will exit with status 1.

```APIDOC
## func Middleware(cmds ...string) wish.Middleware

### Description
Middleware will exit 1 connections trying to execute commands that are not allowed. If no allowed commands are provided, no commands will be allowed.

### Parameters
- **cmds** (...string) - Required - A variadic list of allowed command strings.
```

--------------------------------

### func Middleware

Source: https://pkg.go.dev/github.com/charmbracelet/wish/ratelimiter

Provides a wish middleware that enforces rate limiting on SSH sessions.

```APIDOC
## func Middleware(limiter RateLimiter) wish.Middleware

### Description
Provides a new rate limiting middleware for wish, using the provided RateLimiter implementation to check if a session is allowed to proceed.

### Parameters
- **limiter** (RateLimiter) - The RateLimiter instance to use for checking session eligibility.

### Returns
- **wish.Middleware** - A middleware function compatible with the wish framework.
```

--------------------------------

### NewFSReadHandler Function

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Returns a read-only handler that accepts any fs.FS as input.

```go
func NewFSReadHandler(fsys fs.FS) CopyToClientHandler
```

--------------------------------

### ProgramHandler Type

Source: https://pkg.go.dev/github.com/charmbracelet/wish/bubbletea

Defines a function that returns a tea.Program for custom SSH middleware implementations.

```go
type ProgramHandler func(sess ssh.Session) *tea.Program
```

--------------------------------

### func MiddlewareWithFormat

Source: https://pkg.go.dev/github.com/charmbracelet/wish/elapsed

Returns a middleware that logs the elapsed time of the session using a custom format string.

```APIDOC
## func MiddlewareWithFormat(format string)

### Description
Returns a middleware that logs the elapsed time of the session. It accepts a format string to print the elapsed time. In order to provide an accurate elapsed time for the entire session, this must be called as the last middleware in the chain.

### Signature
`func MiddlewareWithFormat(format string) wish.Middleware`

### Parameters
- **format** (string) - Required - The format string used to print the elapsed time.
```

--------------------------------

### Op Type and Constants

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Defines the type of SCP operation.

```go
type Op byte
```

```go
const (
	// OpCopyToClient is when a file is being copied from the server to the client.
	OpCopyToClient Op = 'f'

	// OpCopyFromClient is when a file is being copied from the client into the server.
	OpCopyFromClient Op = 't'
)
```

--------------------------------

### func Middleware

Source: https://pkg.go.dev/github.com/charmbracelet/wish/recover

Middleware is a wish middleware that recovers from panics and logs to stderr.

```APIDOC
## func Middleware(mw ...wish.Middleware) wish.Middleware

### Description
Middleware is a wish middleware that recovers from panics and logs to stderr.

### Parameters
- **mw** (...wish.Middleware) - Required - A variadic list of wish middleware to wrap.
```

--------------------------------

### NewFSReadHandler

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Creates a read-only handler that allows copying files from the server to the client using an fs.FS interface.

```APIDOC
## func NewFSReadHandler(fsys fs.FS) CopyToClientHandler

### Description
Returns a read-only CopyToClientHandler that accepts any fs.FS as input, enabling file transfers from the server to the client.

### Parameters
- **fsys** (fs.FS) - Required - The file system to read from.
```

--------------------------------

### Session Output Functions

Source: https://pkg.go.dev/github.com/charmbracelet/wish

Functions for printing to a session's STDOUT or STDERR.

```APIDOC
## Print/Error Functions

### Description
Utilities to write formatted or unformatted text to a session's STDOUT or STDERR. Fatal variants will exit the session with status 1.

### Functions
- `Print(s ssh.Session, v ...interface{})`
- `Printf(s ssh.Session, f string, v ...interface{})`
- `Println(s ssh.Session, v ...interface{})`
- `Error(s ssh.Session, v ...interface{})`
- `Errorf(s ssh.Session, f string, v ...interface{})`
- `Errorln(s ssh.Session, v ...interface{})`
- `Fatal(s ssh.Session, v ...interface{})`
- `Fatalf(s ssh.Session, f string, v ...interface{})`
- `Fatalln(s ssh.Session, v ...interface{})`
```

--------------------------------

### Middleware function signature

Source: https://pkg.go.dev/github.com/charmbracelet/wish/comment

Defines the Middleware function which accepts a comment string and returns a wish.Middleware.

```go
func Middleware(comment string) wish.Middleware
```

--------------------------------

### func MakeRenderer

Source: https://pkg.go.dev/github.com/charmbracelet/wish/bubbletea

Returns a lipgloss renderer for the current session, handling PTYs for styling applications.

```APIDOC
## func MakeRenderer(sess ssh.Session) *lipgloss.Renderer

### Description
MakeRenderer returns a lipgloss renderer for the current session. This function handles PTYs as well, and should be used to style your application.

### Parameters
- **sess** (ssh.Session) - Required - The SSH session to create the renderer for.
```

--------------------------------

### Logger Interface Definition

Source: https://pkg.go.dev/github.com/charmbracelet/wish/logging

Interface definition for custom loggers used by the middleware.

```go
type Logger interface {
	Printf(format string, v ...interface{})
}
```

--------------------------------

### RateLimiter Interface Definition

Source: https://pkg.go.dev/github.com/charmbracelet/wish/ratelimiter

Defines the interface for checking if an SSH session is allowed to proceed.

```go
type RateLimiter interface {
	Allow(s ssh.Session) error
}
```

--------------------------------

### Fatal Session Errors

Source: https://pkg.go.dev/github.com/charmbracelet/wish

Functions that print to STDERR and terminate the session with an exit code of 1.

```go
func Fatal(s ssh.Session, v ...interface{})
```

```go
func Fatalf(s ssh.Session, f string, v ...interface{})
```

```go
func Fatalln(s ssh.Session, v ...interface{})
```

--------------------------------

### AppendableEntry Interface

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Defines an entry type capable of containing children.

```go
type AppendableEntry interface {
	// Write the current entry in SCP format.
	Write(io.Writer) error

	// Append another entry to the current entry.
	Append(entry Entry)
}
```

--------------------------------

### func MiddlewareWithLogger

Source: https://pkg.go.dev/github.com/charmbracelet/wish/recover

MiddlewareWithLogger is a wish middleware that recovers from panics and logs to the provided logger.

```APIDOC
## func MiddlewareWithLogger(logger Logger, mw ...wish.Middleware) wish.Middleware

### Description
MiddlewareWithLogger is a wish middleware that recovers from panics and logs to the provided logger.

### Parameters
- **logger** (Logger) - Required - The logger interface to use for logging panics.
- **mw** (...wish.Middleware) - Required - A variadic list of wish middleware to wrap.
```

--------------------------------

### func Middleware

Source: https://pkg.go.dev/github.com/charmbracelet/wish/activeterm

The Middleware function returns a wish.Middleware that exits connections with no active terminals.

```APIDOC
## func Middleware()

### Description
Middleware will exit connections that have no active terminals.

### Signature
`func Middleware() wish.Middleware`
```

--------------------------------

### Error variables

Source: https://pkg.go.dev/github.com/charmbracelet/wish/git

Standard error variables used to indicate specific failure states during Git operations.

```go
var ErrInvalidRepo = errors.New("invalid repo")
```

```go
var ErrNotAuthed = errors.New("you are not authorized to do this")
```

```go
var ErrSystemMalfunction = errors.New("something went wrong")
```

--------------------------------

### type CopyFromClientHandler

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

CopyFromClientHandler is a handler that can be implemented to handle files being copied from the client to the server.

```APIDOC
## type CopyFromClientHandler

### Description
CopyFromClientHandler is a handler that can be implemented to handle files being copied from the client to the server.

### Methods
- **Mkdir(ssh.Session, *DirEntry) error**: Should create the given dir.
- **Write(ssh.Session, *FileEntry) (int64, error)**: Should write the given file.
```

--------------------------------

### Define Rate Limit Exceeded Error

Source: https://pkg.go.dev/github.com/charmbracelet/wish/ratelimiter

Represents the error returned when a connection is denied due to exceeding the rate limit.

```go
var ErrRateLimitExceeded = errors.New("rate limit exceeded, please try again later")
```

--------------------------------

### NULL Variable Definition

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

Represents an array containing a single NULL byte.

```go
var NULL = []byte{'�'}
```

--------------------------------

### type CopyToClientHandler

Source: https://pkg.go.dev/github.com/charmbracelet/wish/scp

CopyToClientHandler is a handler that can be implemented to handle files being copied from the server to the client.

```APIDOC
## type CopyToClientHandler

### Description
CopyToClientHandler is a handler that can be implemented to handle files being copied from the server to the client.

### Methods
- **Glob(ssh.Session, string) ([]string, error)**: Should be implemented if you want to provide server-side globbing support.
- **WalkDir(ssh.Session, string, fs.WalkDirFunc) error**: Must be implemented if you want to allow recursive copies.
- **NewDirEntry(ssh.Session, string) (*DirEntry, error)**: Should provide a *DirEntry for the given path.
```

--------------------------------

### BubbleTeaHandler Type

Source: https://pkg.go.dev/github.com/charmbracelet/wish/bubbletea

Deprecated type alias for Handler.

```go
type BubbleTeaHandler = Handler // nolint: revive
```

--------------------------------

### GitHooks type alias

Source: https://pkg.go.dev/github.com/charmbracelet/wish/git

Deprecated alias for the Hooks interface.

```go
type GitHooks = Hooks // nolint: revive
```

--------------------------------

### QueryTerminalFilter Type

Source: https://pkg.go.dev/github.com/charmbracelet/wish/bubbletea

Defines a filter function for input events; returning false stops input reading.

```go
type QueryTerminalFilter func(events []input.Event) bool
```

--------------------------------

### Write to Session STDERR

Source: https://pkg.go.dev/github.com/charmbracelet/wish

Functions for writing error messages to the SSH session's standard error stream.

```go
func Error(s ssh.Session, v ...interface{})
```

```go
func Errorf(s ssh.Session, f string, v ...interface{})
```

```go
func Errorln(s ssh.Session, v ...interface{})
```
Tokens:
Raw