Giraffe

This is the documentation for version 0.10.0 of Giraffe. For older or newer versions, see the main site.

Installing

Giraffe is published as a Maven-style artifact, but we recommend using Gradle for builds:

repositories {
    jcenter()
}

dependencies {
    compile 'com.palantir.giraffe:giraffe-ssh:0.10.0'
    // or 'com.palantir.giraffe:giraffe-core:0.10.0' for local features only
}

Overview

New users or users looking for a summary of functionality should read Giraffe Basics. This will enable you to start writing code that uses Giraffe and give you the background assumed by the rest of the documentation.

• Giraffe Basics
  • Accessing Files
  • Executing Commands

Learn More

For details on best practices and anti-patterns, see Effective Giraffe. For low-level details, see the full API Documentation.

• Effective Giraffe
  • Connection Management
  • Exception Handling
  • File Operations
  • Command Execution
• API Documentation

Release History

The list of changes in this release and all previous releases can be found in the Changelog. To understand how version numbers correspond to API changes, see About Version Numbers.