github.com/Racer159/jackal@v0.32.7-0.20240401174413-0bd2339e4f2e/docs/2-the-jackal-cli/100-cli-commands/jackal_connect.md (about)

     1  # jackal connect
     2  <!-- Auto-generated by hack/gen-cli-docs.sh -->
     3  
     4  Accesses services or pods deployed in the cluster
     5  
     6  ## Synopsis
     7  
     8  Uses a k8s port-forward to connect to resources within the cluster referenced by your kube-context.
     9  Three default options for this command are <REGISTRY|LOGGING|GIT>. These will connect to the Jackal created resources (assuming they were selected when performing the `jackal init` command).
    10  
    11  Packages can provide service manifests that define their own shortcut connection options. These options will be printed to the terminal when the package finishes deploying.
    12   If you don't remember what connection shortcuts your deployed package offers, you can search your cluster for services that have the 'jackal.dev/connect-name' label. The value of that label is the name you will pass into the 'jackal connect' command.
    13  
    14  Even if the packages you deploy don't define their own shortcut connection options, you can use the command flags to connect into specific resources. You can read the command flag descriptions below to get a better idea how to connect to whatever resource you are trying to connect to.
    15  
    16  ```
    17  jackal connect { REGISTRY | LOGGING | GIT | connect-name } [flags]
    18  ```
    19  
    20  ## Options
    21  
    22  ```
    23        --cli-only           Disable browser auto-open
    24    -h, --help               help for connect
    25        --local-port int     (Optional, autogenerated if not provided) Specify the local port to bind to.  E.g. local-port=42000
    26        --name string        Specify the resource name.  E.g. name=unicorns or name=unicorn-pod-7448499f4d-b5bk6
    27        --namespace string   Specify the namespace.  E.g. namespace=default (default "jackal")
    28        --remote-port int    Specify the remote port of the resource to bind to.  E.g. remote-port=8080
    29        --type string        Specify the resource type.  E.g. type=svc or type=pod (default "svc")
    30  ```
    31  
    32  ## Options inherited from parent commands
    33  
    34  ```
    35    -a, --architecture string   Architecture for OCI images and Jackal packages
    36        --insecure              Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture.
    37    -l, --log-level string      Log level when running Jackal. Valid options are: warn, info, debug, trace (default "info")
    38        --no-color              Disable colors in output
    39        --no-log-file           Disable log file creation
    40        --no-progress           Disable fancy UI progress bars, spinners, logos, etc
    41        --tmpdir string         Specify the temporary directory to use for intermediate files
    42        --jackal-cache string     Specify the location of the Jackal cache directory (default "~/.jackal-cache")
    43  ```
    44  
    45  ## SEE ALSO
    46  
    47  * [jackal](jackal.md)	 - DevSecOps for Airgap
    48  * [jackal connect list](jackal_connect_list.md)	 - Lists all available connection shortcuts