<commit_before># Pachyderm File System CLI

## Terms
__repository:__ A repository (aka: repo) is a grouping of data that you want to track changes over. Repos in pfs behave just like repos in Git, except they work over huge datasets instead of just source code. You can take snapshots (commits) on a repo and multiple repos can exist in a single cluster. For example, if you have multiple production databases dumping data into pfs on a hourly or daily basis, it may make sense for each of those to be a separate repo. 

__commit:__ A commit is an immutable snapshot of a repo at a given time. Commits can either be open or closed. An open commit is writable, allowing you to add, change, or remove files. A closed or "committed" commit is read-only and cannot be changed. 

__file/directory:__ Files are the base unit of data in pfs. Files can be organized in directories, just like any normal file system. 


## Commands
#### help
    Usage: pfs help COMMAND
    
    Returns information about a pfs command

#### version
    Usage: pfs version
    
    Returns the currently running version of pfs

#### mount
    Usage: pfs mount REPOSITORY [MOUNTPOINT]
    
    MOUNTPOINT          The local directory used to access the pfs repo. 
                        Defaults to your working directory if unspecified.
    
    Mounts a repo in the distributed file system onto the local mountpoint. 
    
    Return:

Once you mount a repo in pfs to a local mountpoint, any reads or writes pointed at the local mountpoint percolate to the repo in the distributed file system. 

##### Example
    # mount the `user_data` repo in pfs to your working directory
    $pfs mount user_data

    # mount the `user_data` repo in pfs to your home directory
    $pfs mount user_data ~



### Commands that can be called on a repository:
#### init
    Usage: pfs init REPOSITORY
    <commit_msg>Update pfs.md<commit_after># Pachyderm File System CLI

## Terms
__repository:__ A repository (aka: repo) is a set of data over which you want to track changes. Repos in pfs behave just like repos in Git, except they work over huge datasets instead of just source code. You can take snapshots (commits) on a repo and multiple repos can exist in a single cluster. For example, if you have multiple production databases dumping data into pfs on a hourly or daily basis, it may make sense for each of those to be a separate repo. 

__commit:__ A commit is an immutable snapshot of a repo at a given time. Commits can either be open or closed. An open commit is writable, allowing you to add, change, or remove files. A closed or "committed" commit is read-only and cannot be changed. 

__file/directory:__ Files are the base unit of data in pfs. Files can be organized in directories, just like any normal file system. 


## Commands
#### help
    Usage: pfs help COMMAND
    
    Returns information about a pfs command
    
##### Example
    # Learn more about the `get` command
    $pfs help get

#### version
    Usage: pfs version
    
    Returns the currently running version of pfs
    
##### Example
    # Find out the running version of Pachyderm
    $pfs version
    Pachyderm v0.9

#### mount
    Usage: pfs mount REPOSITORY [MOUNTPOINT]
    
    MOUNTPOINT          The local directory used to access the pfs repo. 
                        Defaults to your working directory if unspecified.
    
    Mounts a repo in the distributed file system onto the local mountpoint. 
    
    Return:

Once you mount a repo in pfs to a local mountpoint, any reads or writes pointed at the local mountpoint are applied to the repo in the distributed file system. 

##### Example
    # mount the `user_data` repo in pfs to your working directory
    $pfs mount user_data

    # mount the `user_data` repo in pfs to your home directory
    $pfs mount user_data ~



### Commands that can be called on a repository:
#### init
    Usage: pfs init REPOSITORY
    
{'fraction_non_alphanumeric': 0.04678362573099415, 'fraction_numerical': 0.0005085176709890668, 'mean_word_length': 3.1280167890870936, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4785899', 'n_tokens_mistral': 1072, 'n_tokens_neox': 1007, 'n_words': 598}