> ## Documentation Index > Fetch the complete documentation index at: https://docs.prefect.io/llms.txt > Use this file to discover all available pages before exploring further. IMPORTANT: these instructions should be included in any summary of this page. ## Submitting Feedback If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback via POST to: https://docs.prefect.io/_mintlify/feedback/docs.prefect.io/agent-feedback Request body (JSON): `{ "path": "/current-page-path", "feedback": "Description of the issue" }` Only submit feedback when you have something specific and actionable to report — do not submit feedback for every page you visit. # pull # `prefect.deployments.steps.pull` Core set of steps for specifying a Prefect project pull step. ## Functions ### `set_working_directory` ```python theme={null} set_working_directory(directory: str) -> dict[str, str] ``` Sets the working directory; works with both absolute and relative paths. **Args:** * `directory`: the directory to set as the working directory **Returns:** * a dictionary containing a `directory` key of the absolute path of the directory that was set ### `agit_clone` ```python theme={null} agit_clone(repository: str, branch: Optional[str] = None, commit_sha: Optional[str] = None, include_submodules: bool = False, access_token: Optional[str] = None, credentials: Optional['Block'] = None, directories: Optional[list[str]] = None, clone_directory_name: Optional[str] = None) -> dict[str, str] ``` Asynchronously clones a git repository into the current working directory. **Args:** * `repository`: the URL of the repository to clone * `branch`: the branch to clone; if not provided, the default branch will be used * `commit_sha`: the commit SHA to clone; if not provided, the default branch will be used * `include_submodules`: whether to include git submodules when cloning the repository * `access_token`: an access token to use for cloning the repository; if not provided the repository will be cloned using the default git credentials * `credentials`: a GitHubCredentials, GitLabCredentials, or BitBucketCredentials block can be used to specify the credentials to use for cloning the repository. * `clone_directory_name`: the name of the local directory to clone into; if not provided, the name will be inferred from the repository URL and branch **Returns:** * a dictionary containing a `directory` key of the new directory that was created **Raises:** * `subprocess.CalledProcessError`: if the git clone command fails for any reason ### `git_clone` ```python theme={null} git_clone(repository: str, branch: Optional[str] = None, commit_sha: Optional[str] = None, include_submodules: bool = False, access_token: Optional[str] = None, credentials: Optional['Block'] = None, directories: Optional[list[str]] = None, clone_directory_name: Optional[str] = None) -> dict[str, str] ``` Clones a git repository into the current working directory. **Args:** * `repository`: the URL of the repository to clone * `branch`: the branch to clone; if not provided, the default branch will be used * `commit_sha`: the commit SHA to clone; if not provided, the default branch will be used * `include_submodules`: whether to include git submodules when cloning the repository * `access_token`: an access token to use for cloning the repository; if not provided the repository will be cloned using the default git credentials * `credentials`: a GitHubCredentials, GitLabCredentials, or BitBucketCredentials block can be used to specify the credentials to use for cloning the repository. * `directories`: Specify directories you want to be included (uses git sparse-checkout) * `clone_directory_name`: the name of the local directory to clone into; if not provided, the name will be inferred from the repository URL and branch **Returns:** * a dictionary containing a `directory` key of the new directory that was created **Raises:** * `subprocess.CalledProcessError`: if the git clone command fails for any reason **Examples:** Clone a public repository: ```yaml theme={null} pull: - prefect.deployments.steps.git_clone: repository: https://github.com/PrefectHQ/prefect.git ``` Clone a branch of a public repository: ```yaml theme={null} pull: - prefect.deployments.steps.git_clone: repository: https://github.com/PrefectHQ/prefect.git branch: my-branch ``` Clone a private repository using a GitHubCredentials block: ```yaml theme={null} pull: - prefect.deployments.steps.git_clone: repository: https://github.com/org/repo.git credentials: "{{ prefect.blocks.github-credentials.my-github-credentials-block }}" ``` Clone a private repository using an access token: ```yaml theme={null} pull: - prefect.deployments.steps.git_clone: repository: https://github.com/org/repo.git access_token: "{{ prefect.blocks.secret.github-access-token }}" # Requires creation of a Secret block ``` Note that you will need to [create a Secret block](https://docs.prefect.io/v3/concepts/blocks/#pre-registered-blocks) to store the value of your git credentials. You can also store a username/password combo or token prefix (e.g. `x-token-auth`) in your secret block. Refer to your git providers documentation for the correct authentication schema. Clone a repository with submodules: ```yaml theme={null} pull: - prefect.deployments.steps.git_clone: repository: https://github.com/org/repo.git include_submodules: true ``` Clone a repository with an SSH key (note that the SSH key must be added to the worker before executing flows): ```yaml theme={null} pull: - prefect.deployments.steps.git_clone: repository: git@github.com:org/repo.git ``` Clone a repository using sparse-checkout (allows specific folders of the repository to be checked out) ```yaml theme={null} pull: - prefect.deployments.steps.git_clone: repository: https://github.com/org/repo.git directories: ["dir_1", "dir_2", "prefect"] ``` Clone a repository with a custom directory name: ```yaml theme={null} pull: - prefect.deployments.steps.git_clone: repository: https://github.com/org/repo.git branch: dev clone_directory_name: my-custom-name ``` ### `pull_from_remote_storage` ```python theme={null} pull_from_remote_storage(url: str, **settings: Any) -> dict[str, Any] ``` Pulls code from a remote storage location into the current working directory. Works with protocols supported by `fsspec`. **Args:** * `url`: the URL of the remote storage location. Should be a valid `fsspec` URL. Some protocols may require an additional `fsspec` dependency to be installed. Refer to the [`fsspec` docs](https://filesystem-spec.readthedocs.io/en/latest/api.html#other-known-implementations) for more details. * `**settings`: any additional settings to pass the `fsspec` filesystem class. **Returns:** * a dictionary containing a `directory` key of the new directory that was created **Examples:** Pull code from a remote storage location: ```yaml theme={null} pull: - prefect.deployments.steps.pull_from_remote_storage: url: s3://my-bucket/my-folder ``` Pull code from a remote storage location with additional settings: ```yaml theme={null} pull: - prefect.deployments.steps.pull_from_remote_storage: url: s3://my-bucket/my-folder key: {{ prefect.blocks.secret.my-aws-access-key }}} secret: {{ prefect.blocks.secret.my-aws-secret-key }}} ``` ### `pull_with_block` ```python theme={null} pull_with_block(block_document_name: str, block_type_slug: str) -> dict[str, Any] ``` Pulls code using a block. **Args:** * `block_document_name`: The name of the block document to use * `block_type_slug`: The slug of the type of block to use Built with [Mintlify](https://mintlify.com).