欢迎访问 Fabric 中文版文档！

本站覆盖了 Fabric 的用法和 API 文档。若想了解 Fabric 是什么，包括它的更新日志和如何维护该项目，请访问 Fabric 项目官方网站 。

入门指导

对于新用户，与/或想大概了解 Fabric 的基本功能的同学，请看 入门导览 。本文档的其他部分将假设你至少已经大概熟悉其中的内容。

用法文档

下面的列表包含了 Fabric 散文（非 API）文档的所有主要章节。这些内容在 入门导览 中提到的概念基础上进行了扩展，并覆盖了一些进阶主题。

• 环境字典 env
  • 环境与配置
  • 共享状态环境
  • 其他考虑
  • 环境变量完整列表
• Execution model
  • Execution strategy
  • Defining tasks
  • Defining host lists
  • Intelligently executing tasks with execute
  • Failure handling
  • Connections
  • Password management
  • Leveraging native SSH config files
• fab options and arguments
  • Basic use
  • Arbitrary remote shell commands
  • Command-line options
  • Per-task arguments
  • Settings files
• Fabfile construction and use
  • Fabfile discovery
  • Importing Fabric
  • Defining tasks and importing callables
• Interaction with remote programs
  • Combining stdout and stderr
  • Pseudo-terminals
  • Combining the two
• Library Use
  • Connections
  • Disconnecting
  • Final note
• Managing output
  • Output levels
  • Hiding and/or showing output levels
• Parallel execution
  • What it does
  • How to use it
  • Bubble size
  • Linewise vs bytewise output
• SSH behavior
  • Unknown hosts
  • Known hosts with changed keys
• Defining tasks
  • New-style tasks
  • Classic tasks

API 文档

Fabric 维护了两套 API 文档，它们都是根据代码中的 docstring 自动生成的，也十分详尽。

核心 API

核心 API 是指构成 Fabric 基础构建块的函数、类和方法（例如 ~fabric.operations.run 和 ~fabric.operations.sudo）。而其他部分（下文的“扩展 API”和用户的 fabfile）都是在这些核心 API 的基础之上构建的。

扩展 API

Fabric 的 扩展 包包括常用而有用的工具（通常是从用户的 fabfile 中合并进来的），可用于用户 I/O、修改远程文件等任务中。核心 API 倾向于保持小巧、不随意变更，扩展包则会随着更多的用户案例被解决并添加进来，而不断成长进化（同时尽量保持向后兼容）。

• Console Output Utilities
• Django Integration
• File and Directory Management
• Project Tools