cli: add: add an --output argument

dvc/command/add.py

@@ -18,6 +18,12 @@ def run(self):
             if len(self.args.targets) > 1 and self.args.file:
                 raise RecursiveAddingWhileUsingFilename()
 
+            if len(self.args.targets) != 1 and self.args.output:
+                logger.error(
+                    "cannot add more than one file when using --output"
+                )
+                return 1
+
             self.repo.add(
                 self.args.targets,
                 recursive=self.args.recursive,
@@ -26,6 +32,7 @@ def run(self):
                 external=self.args.external,
                 glob=self.args.glob,
                 desc=self.args.desc,
+                output=self.args.output,
             )
 
         except DvcException:
@@ -83,6 +90,13 @@ def add_parser(subparsers, parent_parser):
             "This doesn't affect any DVC operations."
         ),
     )
+    parser.add_argument(
+        "-o",
+        "--output",
+        type=str,
+        metavar="<path>",
+        help="Output path for the file, if it lives outside the repo.",
+    )
     parser.add_argument(
         "targets", nargs="+", help="Input files/directories to add.",
     ).complete = completion.FILE

dvc/exceptions.py

@@ -60,6 +60,24 @@ def __init__(self, output, repo=None):
         )
 
 
+class OutputNotCreatedError(DvcException):
+    """Thrown if the specified output file could not be created.
+
+    Args:
+        output (unicode): path to the file
+    """
+
+    def __init__(self, output):
+        from dvc.utils import relpath
+
+        self.output = output
+        super().__init__(
+            "Unable to create output file '{path}'".format(
+                path=relpath(self.output)
+            )
+        )
+
+
 class StagePathAsOutputError(DvcException):
     """Thrown if directory that stage is going to be saved in is specified as
     an output of another stage.

dvc/repo/add.py

@@ -1,12 +1,14 @@
 import logging
 import os
+import shutil
 from typing import TYPE_CHECKING
 
 import colorama
 
 from ..exceptions import (
     CacheLinkError,
     OutputDuplicationError,
+    OutputNotCreatedError,
     OverlappingOutputPathsError,
     RecursiveAddingWhileUsingFilename,
 )
@@ -30,6 +32,7 @@ def add(
     recursive=False,
     no_commit=False,
     fname=None,
+    output=None,
     **kwargs,
 ):
     from dvc.utils.collections import ensure_list
@@ -38,6 +41,20 @@ def add(
         raise RecursiveAddingWhileUsingFilename()
 
     targets = ensure_list(targets)
+
+    if output:
+        try:
+            dname = os.path.dirname(output)
+
+            if dname and not os.path.isdir(dname):
+                os.makedirs(dname)
+
+            shutil.copy2(targets[0], output)
+
+            targets = [output]
+        except OSError:
+            raise OutputNotCreatedError(output)
+
     link_failures = []
     stages_list = []
     num_targets = len(targets)

tests/func/test_add.py

@@ -4,6 +4,7 @@
 import os
 import shutil
 import stat
+import tempfile
 import textwrap
 import time
 
@@ -59,6 +60,40 @@ def test_add(tmp_dir, dvc):
     }
 
 
+def test_add_output(tmp_dir, dvc):
+    (fd, fname) = tempfile.mkstemp()
+    os.write(fd, b"foo")
+    os.close(fd)
+
+    ret = main(["add", "--output", "foo", "bar", "baz"])
+    assert ret == 1
+
+    md5, _ = file_md5(fname)
+    stage = dvc.add(fname, output="foo")[0]
+
+    assert stage is not None
+
+    assert isinstance(stage, Stage)
+    assert os.path.isfile(stage.path)
+    assert len(stage.outs) == 1
+    assert len(stage.deps) == 0
+    assert stage.cmd is None
+    assert stage.outs[0].hash_info == HashInfo("md5", md5)
+    assert stage.md5 is None
+
+    assert load_yaml("foo.dvc") == {
+        "outs": [
+            {
+                "md5": "acbd18db4cc2f85cedef654fccc4a4d8",
+                "path": "foo",
+                "size": 3,
+            }
+        ],
+    }
+
+    os.unlink(fname)
+
+
 @pytest.mark.skipif(os.name == "nt", reason="can't set exec bit on Windows")
 def test_add_executable(tmp_dir, dvc):
     tmp_dir.gen("foo", "foo")