<commit_before>---
title: ufo init
reference: true
---

## Usage

    ufo new --app=APP --image=IMAGE

## Description

Set up initial ufo files.

The `ufo init` command provides a way to quickly setup a project to be ufo ready. It creates a ufo folder with all the starter supporting files in order to use ufo.  This page demonstrates how to use `ufo init`.  The command requires these options: `--app` and `--image`.

## Examples

For this example we will use [tongueroo/hi](https://github.com/tongueroo/hi) which is a small test sinatra app.  Let's run the command in our newly clone project.

    $ git clone https://github.com/tongueroo/hi.git
    $ cd hi
    $ ufo init --app=hi --image=tongueroo/hi
    Setting up ufo project...
          create  .ufo/settings.yml
          create  .ufo/task_definitions.rb<commit_msg>docs updated by circleci<commit_after>---
title: ufo init
reference: true
---

## Usage

    ufo init --app=APP --image=IMAGE

## Description

Set up initial ufo files.

The `ufo init` command provides a way to quickly setup a project to be ufo ready. It creates a ufo folder with all the starter supporting files in order to use ufo.  This page demonstrates how to use `ufo init`.  The command requires these options: `--app` and `--image`.

## Examples

For this example we will use [tongueroo/hi](https://github.com/tongueroo/hi) which is a small test sinatra app.  Let's run the command in our newly clone project.

    $ git clone https://github.com/tongueroo/hi.git
    $ cd hi
    $ ufo init --app=hi --image=tongueroo/hi
    Setting up ufo project...
          create  .ufo/settings.yml
          create  .ufo/task_definitions.rb
{'fraction_non_alphanumeric': 0.09747292418772563, 'fraction_numerical': 0.0, 'mean_word_length': 2.885514018691589, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, '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': '4482771', 'n_tokens_mistral': 529, 'n_tokens_neox': 514, 'n_words': 214}