Expand description
Agentknock is primarily a command-line application.
Start with the Agentknock README for installation, usage, and project documentation.
The public items below form the unstable Agentknock embedding API. Direct use of this API is not currently recommended.
Structs§
- Application
Info - Identifies the application that uses the Agentknock library.
- Client
- Performs Agentknock operations using one local pairing.
- Environment
Variable Options - Configures which variables an environment secret delivers and where.
- GitSign
Changed Path - Describes one path changed by the object being signed.
- GitSign
Repository - Advisory repository information for a Git signature request.
- GitSign
Request - Describes one Git signature requested by a command invocation.
- Pairing
Sas - A short authentication string for verifying an initial pairing.
- Secret
UseInvocation - Identifies and authenticates operations that belong to one command invocation.
- Secret
UseOptions - Configures how one requested secret is delivered.
- Secret
UseOutput - Secret material and related authorization returned for an invocation.
- Secret
UseRequest - Describes an invocation request that selects one or more secrets.
- SshAuthentication
Request - Describes one SSH authentication requested by a command invocation.
- SshSecret
Use - An SSH secret made available to a command invocation.
Enums§
- Configuration
Error - An error reading or updating local Agentknock state.
- Denial
Reason - The reason that the device denied an authorization request.
- Executable
Mode - The form of a selected executable.
- GitSign
Change Status - Describes how a path changed in a signed Git object.
- GitSign
Head - Describes the repository HEAD associated with a Git signature request.
- Pairing
Remove Error - An error removing an active pairing.
- Pairing
Status - The state of the pairing stored on this client.
- Request
Error - An error during an operation that communicates with the relay or device.
- Request
Progress - A stage reported while an operation exchanges messages with the device.
- Secret
- Metadata for a secret available from the paired device.
- Secret
Upload - A secret to upload to the device.
- Secret
Upload Error - An error uploading a secret.
- Secret
Upload Mode - How an uploaded secret changes device state after user acceptance.
- Secret
UseOperation - A command operation described by an invocation request.
- SshSignature
Algorithm - An SSH signature algorithm supported by Agentknock.
- Stream
Kind - Describes how a command’s standard stream is connected.
Type Aliases§
- Secrets
- Secret metadata keyed by secret name.