co 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33b0f645332faffdf5d106d4e4b3ae69a88d055d
+  data.tar.gz: 12835f2e27c9f554f6b56aa71bc430e146e58024
+SHA512:
+  metadata.gz: 68942169a3e85d54ea386c571b47db755642d054df2f7ddf03d0af34e6b3ec90e6ea6546fa042491df47f175bb3263cdf826b1ac181dce09b4d64eba085d1a00
+  data.tar.gz: db9d7346e7b5504c5df2058786a2e789f336216c387429c0d6e1ffe5269e69409c0c01f6fc9e21204a3316ba635951b7948c084aff1cf09234891d8bea6ca48e

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in co.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 0catac0
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,108 @@
+# Co
+
+Co stands for Command Organizer.
+
+You may use co to remember and organize shell commands.
+
+Imagine you have successfully figured out the command to do a firewall scan for MAC address spoofing, say:
+
+    nmap -v -sT -PN --spoof-mac 0 192.168.1.1
+
+Chances are that the next time you want to do a firewall scan, you have forgotten the arguments. If you are lucky you may find the command with a combination of 'grep' and 'history'. 
+
+For these situations you can use co.
+
+After you have executed a command that you might want to reuse later;
+
+    $ co save
+
+This will save the command for reuse. By default co will tag this command with the current directory. 
+
+At a later stage just;
+
+    $ co
+
+And use the arrow keys to cycle the commands that are tagged with the directory that you are currently in. If you wish change some arguments and then press enter to execute the (modified) command.
+
+Besides the automatic pwd tags, you may also define your own tags. And specify a message that helps you remember the exact use for the command. 
+For the nmap example you could use:
+
+    $ co save @scan @nmap -m "perform firewall scan with random mac"
+
+At a later stage, when you need to do a scan, you can;
+
+    $ co list @scan
+
+And co will print a list of commands that tagged with @scan, with an id and the message you provided:
+
+    3 | nmap -v -sT -PN --spoof-mac 0 192.168.1.1 | perform firewall scan with random mac
+
+To execute the command you can;
+
+    $ co 3
+
+## Installation
+
+ Install co with:
+
+    $ gem install co
+
+
+IMPORTANT:
+
+You need to include the following export into your bash profile.
+
+    `export PROMPT_COMMAND="history -a;"$PROMPT_COMMAND`
+
+After this bash will sync your history file on every command. 
+Without it, co will save the last command of your previous session every time.
+
+## Usage
+
+- co save [@tag] [@tag] [-m message]
+
+	Save last command from history to the database.
+	Co automatically tags the saved command with @[pwd].
+	Tags should start with the @ character to be recognized as such.
+	The -m message should be provided within quotes "".
+
+- co
+
+	Cycles through commands tagged with [@pwd]. 
+	If there are no commands found in the database, the command falls through.
+
+- co @tag
+
+	Cycles through commands tagged with @tag
+	If there are no commands found in the database, the command falls through.
+
+- co list [all] [@tag]
+
+	without optional arguments: lists commands for @[pwd]
+	all: lists all commands in the database
+	@tag: lists commands for @tag
+
+- co id
+
+	execute command identified by id (integer)
+
+- co delete id
+
+	delete command identified by id
+	
+## Configuration
+
+By default the database is created as ~/.co/co.db.
+
+Co looks for a .coconfig file in your home directory.
+In this config file, you may specify a custom location for a database as a key value pair, with 'db' as the key;
+
+  db=/home/0catac0/dropbox/co.db
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/co/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/co

@@ -0,0 +1,150 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "sqlite3"
+require "readline"
+
+#use default_path
+default_path = "#{ENV['HOME']}/.co/co.db"
+path = default_path
+
+#check for coniguration
+if File.exists? "#{ENV['HOME']}/.coconfig"
+	#read config file
+	config = Hash[*File.read("#{ENV['HOME']}/.coconfig").split(/[= \n]+/)]
+	if(config['db'])
+		#set path from config
+		path = config['db']
+	end	
+end
+
+#create default directory if necessary
+if path == default_path
+	Dir.mkdir "#{ENV['HOME']}/.co" unless Dir.exists? "#{ENV['HOME']}/.co"
+end
+
+db = SQLite3::Database.new path 
+db.execute "CREATE TABLE IF NOT EXISTS commands(id INTEGER PRIMARY KEY, cmd TEXT UNIQUE, description TEXT)"
+db.execute "CREATE TABLE IF NOT EXISTS tags(id INTEGER PRIMARY KEY, tag TEXT UNIQUE)"
+db.execute "CREATE TABLE IF NOT EXISTS command_tags(cmd_id INTEGER, tag_id INTEGER, UNIQUE (cmd_id,tag_id) ON CONFLICT REPLACE)"
+
+pwd = `pwd`
+pwd.strip!
+
+options = {}
+optparse = OptionParser.new do |opts|
+	opts.on('-m STR','Provide a description for the command') do | desc |
+		options[:description] = desc
+	end
+end
+optparse.parse!
+
+#Save the last command in the command history to the database
+#NB. for this to work, EXPORT PROMPT_COMMAND="history -a;"
+if(ARGV[0] == 'save')
+
+	cmd = `tail -n 1 ${HOME}/.bash_history`
+	cmd.strip!
+
+	description = options[:description] 
+	
+	#treat any tokens that start with @ as tags
+	tags = []
+	tags << "@#{pwd}"
+	ARGV.each do | token |
+		if(token.start_with? "@")
+			tags << token
+		end
+	end
+	
+	#insert stuff into the database
+	begin
+		#find or insert command
+		db.execute "INSERT OR IGNORE INTO commands(cmd,description) VALUES ('#{cmd}','#{description}');"
+		cmd_id = db.get_first_value "SELECT id from commands WHERE cmd = '#{cmd}';"
+		
+		tags.each do |tag|
+			#find or insert tag
+			db.execute "INSERT OR IGNORE INTO tags(tag) VALUES ('#{tag}')"
+			tag_id = db.get_first_value "SELECT id from tags WHERE tag = '#{tag}';"
+			
+			#insert connection
+			db.execute "INSERT INTO command_tags(cmd_id,tag_id) VALUES (#{cmd_id},#{tag_id})"
+
+		end
+	rescue SQLite3::Exception => e
+		puts e
+	end
+	db.close if db
+	exit #quit
+end
+
+#select all commands in current pwd
+if(ARGV[0] == 'list')
+	tag = "@#{pwd}"
+	if(ARGV[1] != nil && ARGV[1].start_with?("@"))
+		tag = ARGV[1]	
+	end
+	tag_id = db.get_first_value "SELECT id from tags WHERE tag = '#{tag}'"
+	if(tag_id)
+		rows = db.execute "SELECT * from commands WHERE id in (SELECT cmd_id from command_tags where tag_id = '#{tag_id}')"
+		for row in rows do 
+			puts row.join "\s | \s"
+		end
+	end
+end
+
+#delete the command
+if(ARGV[0] == 'delete' && Integer(ARGV[1]) rescue false )
+	cmd_id = ARGV[1].to_i
+	db.execute "DELETE FROM commands WHERE id = #{cmd_id}"
+	db.execute "DELETE FROM command_tags where cmd_id = #{cmd_id}"
+	db.close
+	exit
+end
+
+if(ARGV[0] == 'tags')
+	rows = db.execute "SELECT tag from tags"
+	for row in rows do
+		puts row
+	end
+end
+
+#execute the provided id
+if(Integer(ARGV[0]) rescue false)
+	cmd_id = ARGV[0].to_i
+	cmd = db.get_first_value "SELECT cmd from commands where id = #{cmd_id};"
+	if(cmd)
+		exec cmd
+	end
+end
+
+#Default behaviour
+#Cycle through commands saved for pwd
+if(ARGV.length == 0 || (ARGV[0] != nil && ARGV[0].start_with?("@")))
+	
+	tag = "@#{pwd}"
+	if(ARGV[0] != nil && ARGV[0].start_with?("@"))
+		tag = ARGV[0]	
+	end
+	tag_id = db.get_first_value "SELECT id from tags WHERE tag = '#{tag}'"
+	
+	if(tag_id)
+		rows = db.execute "SELECT * from commands WHERE id in (SELECT cmd_id from command_tags where tag_id = '#{tag_id}')"
+		LIST = []
+		rows.each do | row |
+			Readline::HISTORY << row[1]
+			#LIST << row[1]
+		end
+	
+		#comp = proc {|s| LIST.grep(/^#{Regexp.escape(s)}/)}
+		#Readline.completion_proc = comp
+
+		while line = Readline.readline('co> ', true)
+			if(line != "")
+				system line
+			end
+			break
+		end	
+	end
+end

data/co.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'co/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "co"
+  spec.version       = Co::VERSION
+  spec.authors       = ["0catac0"]
+  spec.email         = ["taco@yavin4.nl"]
+  spec.summary       = %q{Command organizer}
+  spec.description   = %q{Use co to remember and organize shell commands.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency "sqlite3"
+end

data/lib/co/version.rb

@@ -0,0 +1,3 @@
+module Co
+  VERSION = "0.1.0"
+end

data/lib/co.rb

@@ -0,0 +1,5 @@
+require "co/version"
+
+module Co
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: co
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- 0catac0
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use co to remember and organize shell commands.
+email:
+- taco@yavin4.nl
+executables:
+- co
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/co
+- co.gemspec
+- lib/co.rb
+- lib/co/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Command organizer
+test_files: []